1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Copyright IBM Corp. 2006, 2019
4 * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
5 * Martin Schwidefsky <schwidefsky@de.ibm.com>
6 * Ralph Wuerthner <rwuerthn@de.ibm.com>
7 * Felix Beck <felix.beck@de.ibm.com>
8 * Holger Dengler <hd@linux.vnet.ibm.com>
10 * Adjunct processor bus header file.
16 #include <linux/device.h>
17 #include <linux/types.h>
21 #define AP_DEVICES 256 /* Number of AP devices. */
22 #define AP_DOMAINS 256 /* Number of AP domains. */
23 #define AP_IOCTLS 256 /* Number of ioctls. */
24 #define AP_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */
25 #define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */
26 #define AP_POLL_TIME 1 /* Time in ticks between receive polls. */
28 extern int ap_domain_index
;
30 extern spinlock_t ap_list_lock
;
31 extern struct list_head ap_card_list
;
33 static inline int ap_test_bit(unsigned int *ptr
, unsigned int nr
)
35 return (*ptr
& (0x80000000u
>> nr
)) != 0;
38 #define AP_RESPONSE_NORMAL 0x00
39 #define AP_RESPONSE_Q_NOT_AVAIL 0x01
40 #define AP_RESPONSE_RESET_IN_PROGRESS 0x02
41 #define AP_RESPONSE_DECONFIGURED 0x03
42 #define AP_RESPONSE_CHECKSTOPPED 0x04
43 #define AP_RESPONSE_BUSY 0x05
44 #define AP_RESPONSE_INVALID_ADDRESS 0x06
45 #define AP_RESPONSE_OTHERWISE_CHANGED 0x07
46 #define AP_RESPONSE_Q_FULL 0x10
47 #define AP_RESPONSE_NO_PENDING_REPLY 0x10
48 #define AP_RESPONSE_INDEX_TOO_BIG 0x11
49 #define AP_RESPONSE_NO_FIRST_PART 0x13
50 #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15
51 #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16
56 #define AP_DEVICE_TYPE_PCICC 3
57 #define AP_DEVICE_TYPE_PCICA 4
58 #define AP_DEVICE_TYPE_PCIXCC 5
59 #define AP_DEVICE_TYPE_CEX2A 6
60 #define AP_DEVICE_TYPE_CEX2C 7
61 #define AP_DEVICE_TYPE_CEX3A 8
62 #define AP_DEVICE_TYPE_CEX3C 9
63 #define AP_DEVICE_TYPE_CEX4 10
64 #define AP_DEVICE_TYPE_CEX5 11
65 #define AP_DEVICE_TYPE_CEX6 12
66 #define AP_DEVICE_TYPE_CEX7 13
69 * Known function facilities
71 #define AP_FUNC_MEX4K 1
72 #define AP_FUNC_CRT4K 2
73 #define AP_FUNC_COPRO 3
74 #define AP_FUNC_ACCEL 4
75 #define AP_FUNC_EP11 5
76 #define AP_FUNC_APXA 6
81 #define AP_INTR_DISABLED 0 /* AP interrupt disabled */
82 #define AP_INTR_ENABLED 1 /* AP interrupt enabled */
94 AP_STATE_SUSPEND_WAIT
,
95 AP_STATE_REMOVE
, /* about to be removed from driver */
96 AP_STATE_UNBOUND
, /* momentary not bound to a driver */
97 AP_STATE_BORKED
, /* broken */
114 AP_WAIT_AGAIN
, /* retry immediately */
115 AP_WAIT_TIMEOUT
, /* wait for timeout */
116 AP_WAIT_INTERRUPT
, /* wait for thin interrupt (if available) */
117 AP_WAIT_NONE
, /* no wait */
125 * The ap driver struct includes a flags field which holds some info for
126 * the ap bus about the driver. Currently only one flag is supported and
127 * used: The DEFAULT flag marks an ap driver as a default driver which is
128 * used together with the apmask and aqmask whitelisting of the ap bus.
130 #define AP_DRIVER_FLAG_DEFAULT 0x0001
133 struct device_driver driver
;
134 struct ap_device_id
*ids
;
137 int (*probe
)(struct ap_device
*);
138 void (*remove
)(struct ap_device
*);
139 void (*suspend
)(struct ap_device
*);
140 void (*resume
)(struct ap_device
*);
143 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
145 int ap_driver_register(struct ap_driver
*, struct module
*, char *);
146 void ap_driver_unregister(struct ap_driver
*);
149 struct device device
;
150 struct ap_driver
*drv
; /* Pointer to AP device driver. */
151 int device_type
; /* AP device type. */
154 #define to_ap_dev(x) container_of((x), struct ap_device, device)
157 struct ap_device ap_dev
;
158 struct list_head list
; /* Private list of AP cards. */
159 struct list_head queues
; /* List of assoc. AP queues */
160 void *private; /* ap driver private pointer. */
161 int raw_hwtype
; /* AP raw hardware type. */
162 unsigned int functions
; /* AP device function bitfield. */
163 int queue_depth
; /* AP queue depth.*/
164 int id
; /* AP card number. */
165 atomic64_t total_request_count
; /* # requests ever for this AP device.*/
168 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
171 struct ap_device ap_dev
;
172 struct list_head list
; /* Private list of AP queues. */
173 struct ap_card
*card
; /* Ptr to assoc. AP card. */
174 spinlock_t lock
; /* Per device lock. */
175 void *private; /* ap driver private pointer. */
176 ap_qid_t qid
; /* AP queue id. */
177 int interrupt
; /* indicate if interrupts are enabled */
178 int queue_count
; /* # messages currently on AP queue. */
179 enum ap_state state
; /* State of the AP device. */
180 int pendingq_count
; /* # requests on pendingq list. */
181 int requestq_count
; /* # requests on requestq list. */
182 u64 total_request_count
; /* # requests ever for this AP device.*/
183 int request_timeout
; /* Request timeout in jiffies. */
184 struct timer_list timeout
; /* Timer for request timeouts. */
185 struct list_head pendingq
; /* List of message sent to AP queue. */
186 struct list_head requestq
; /* List of message yet to be sent. */
187 struct ap_message
*reply
; /* Per device reply message. */
190 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
192 typedef enum ap_wait (ap_func_t
)(struct ap_queue
*queue
);
195 struct list_head list
; /* Request queueing. */
196 unsigned long long psmid
; /* Message id. */
197 void *message
; /* Pointer to message buffer. */
198 size_t length
; /* Message length. */
199 int rc
; /* Return code for this message */
201 void *private; /* ap driver private pointer. */
202 unsigned int special
:1; /* Used for special commands. */
203 /* receive is called from tasklet context */
204 void (*receive
)(struct ap_queue
*, struct ap_message
*,
205 struct ap_message
*);
209 * ap_init_message() - Initialize ap_message.
210 * Initialize a message before using. Otherwise this might result in
211 * unexpected behaviour.
213 static inline void ap_init_message(struct ap_message
*ap_msg
)
215 memset(ap_msg
, 0, sizeof(*ap_msg
));
219 * ap_release_message() - Release ap_message.
220 * Releases all memory used internal within the ap_message struct
221 * Currently this is the message and private field.
223 static inline void ap_release_message(struct ap_message
*ap_msg
)
225 kzfree(ap_msg
->message
);
226 kzfree(ap_msg
->private);
229 #define for_each_ap_card(_ac) \
230 list_for_each_entry(_ac, &ap_card_list, list)
232 #define for_each_ap_queue(_aq, _ac) \
233 list_for_each_entry(_aq, &(_ac)->queues, list)
236 * Note: don't use ap_send/ap_recv after using ap_queue_message
237 * for the first time. Otherwise the ap message queue will get
240 int ap_send(ap_qid_t
, unsigned long long, void *, size_t);
241 int ap_recv(ap_qid_t
, unsigned long long *, void *, size_t);
243 enum ap_wait
ap_sm_event(struct ap_queue
*aq
, enum ap_event event
);
244 enum ap_wait
ap_sm_event_loop(struct ap_queue
*aq
, enum ap_event event
);
246 void ap_queue_message(struct ap_queue
*aq
, struct ap_message
*ap_msg
);
247 void ap_cancel_message(struct ap_queue
*aq
, struct ap_message
*ap_msg
);
248 void ap_flush_queue(struct ap_queue
*aq
);
250 void *ap_airq_ptr(void);
251 void ap_wait(enum ap_wait wait
);
252 void ap_request_timeout(struct timer_list
*t
);
253 void ap_bus_force_rescan(void);
255 int ap_test_config_usage_domain(unsigned int domain
);
256 int ap_test_config_ctrl_domain(unsigned int domain
);
258 void ap_queue_init_reply(struct ap_queue
*aq
, struct ap_message
*ap_msg
);
259 struct ap_queue
*ap_queue_create(ap_qid_t qid
, int device_type
);
260 void ap_queue_prepare_remove(struct ap_queue
*aq
);
261 void ap_queue_remove(struct ap_queue
*aq
);
262 void ap_queue_suspend(struct ap_device
*ap_dev
);
263 void ap_queue_resume(struct ap_device
*ap_dev
);
264 void ap_queue_init_state(struct ap_queue
*aq
);
266 struct ap_card
*ap_card_create(int id
, int queue_depth
, int raw_device_type
,
267 int comp_device_type
, unsigned int functions
);
270 unsigned long ioctlm
[BITS_TO_LONGS(AP_IOCTLS
)];
271 unsigned long apm
[BITS_TO_LONGS(AP_DEVICES
)];
272 unsigned long aqm
[BITS_TO_LONGS(AP_DOMAINS
)];
274 extern struct ap_perms ap_perms
;
275 extern struct mutex ap_perms_mutex
;
278 * check APQN for owned/reserved by ap bus and default driver(s).
279 * Checks if this APQN is or will be in use by the ap bus
280 * and the default set of drivers.
281 * If yes, returns 1, if not returns 0. On error a negative
282 * errno value is returned.
284 int ap_owned_by_def_drv(int card
, int queue
);
287 * check 'matrix' of APQNs for owned/reserved by ap bus and
289 * Checks if there is at least one APQN in the given 'matrix'
290 * marked as owned/reserved by the ap bus and default driver(s).
291 * If such an APQN is found the return value is 1, otherwise
292 * 0 is returned. On error a negative errno value is returned.
293 * The parameter apm is a bitmask which should be declared
294 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
295 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
297 int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm
,
301 * ap_parse_mask_str() - helper function to parse a bitmap string
302 * and clear/set the bits in the bitmap accordingly. The string may be
303 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple
304 * overwriting the current content of the bitmap. Or as relative string
305 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of
306 * bits are cleared or set. Distinction is done based on the very
307 * first character which may be '+' or '-' for the relative string
308 * and othewise assume to be an absolute value string. If parsing fails
309 * a negative errno value is returned. All arguments and bitmaps are
312 int ap_parse_mask_str(const char *str
,
313 unsigned long *bitmap
, int bits
,
316 #endif /* _AP_BUS_H_ */