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>
18 #include <linux/hashtable.h>
22 #define AP_DEVICES 256 /* Number of AP devices. */
23 #define AP_DOMAINS 256 /* Number of AP domains. */
24 #define AP_IOCTLS 256 /* Number of ioctls. */
25 #define AP_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */
26 #define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */
27 #define AP_POLL_TIME 1 /* Time in ticks between receive polls. */
29 extern int ap_domain_index;
31 extern DECLARE_HASHTABLE(ap_queues, 8);
32 extern spinlock_t ap_queues_lock;
34 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
36 return (*ptr & (0x80000000u >> nr)) != 0;
39 #define AP_RESPONSE_NORMAL 0x00
40 #define AP_RESPONSE_Q_NOT_AVAIL 0x01
41 #define AP_RESPONSE_RESET_IN_PROGRESS 0x02
42 #define AP_RESPONSE_DECONFIGURED 0x03
43 #define AP_RESPONSE_CHECKSTOPPED 0x04
44 #define AP_RESPONSE_BUSY 0x05
45 #define AP_RESPONSE_INVALID_ADDRESS 0x06
46 #define AP_RESPONSE_OTHERWISE_CHANGED 0x07
47 #define AP_RESPONSE_Q_FULL 0x10
48 #define AP_RESPONSE_NO_PENDING_REPLY 0x10
49 #define AP_RESPONSE_INDEX_TOO_BIG 0x11
50 #define AP_RESPONSE_NO_FIRST_PART 0x13
51 #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15
52 #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16
57 #define AP_DEVICE_TYPE_PCICC 3
58 #define AP_DEVICE_TYPE_PCICA 4
59 #define AP_DEVICE_TYPE_PCIXCC 5
60 #define AP_DEVICE_TYPE_CEX2A 6
61 #define AP_DEVICE_TYPE_CEX2C 7
62 #define AP_DEVICE_TYPE_CEX3A 8
63 #define AP_DEVICE_TYPE_CEX3C 9
64 #define AP_DEVICE_TYPE_CEX4 10
65 #define AP_DEVICE_TYPE_CEX5 11
66 #define AP_DEVICE_TYPE_CEX6 12
67 #define AP_DEVICE_TYPE_CEX7 13
70 * Known function facilities
72 #define AP_FUNC_MEX4K 1
73 #define AP_FUNC_CRT4K 2
74 #define AP_FUNC_COPRO 3
75 #define AP_FUNC_ACCEL 4
76 #define AP_FUNC_EP11 5
77 #define AP_FUNC_APXA 6
82 #define AP_INTR_DISABLED 0 /* AP interrupt disabled */
83 #define AP_INTR_ENABLED 1 /* AP interrupt enabled */
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 *);
141 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
143 int ap_driver_register(struct ap_driver *, struct module *, char *);
144 void ap_driver_unregister(struct ap_driver *);
147 struct device device;
148 struct ap_driver *drv; /* Pointer to AP device driver. */
149 int device_type; /* AP device type. */
152 #define to_ap_dev(x) container_of((x), struct ap_device, device)
155 struct ap_device ap_dev;
156 void *private; /* ap driver private pointer. */
157 int raw_hwtype; /* AP raw hardware type. */
158 unsigned int functions; /* AP device function bitfield. */
159 int queue_depth; /* AP queue depth.*/
160 int id; /* AP card number. */
161 atomic64_t total_request_count; /* # requests ever for this AP device.*/
164 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
167 struct ap_device ap_dev;
168 struct hlist_node hnode; /* Node for the ap_queues hashtable */
169 struct ap_card *card; /* Ptr to assoc. AP card. */
170 spinlock_t lock; /* Per device lock. */
171 void *private; /* ap driver private pointer. */
172 ap_qid_t qid; /* AP queue id. */
173 int interrupt; /* indicate if interrupts are enabled */
174 int queue_count; /* # messages currently on AP queue. */
175 enum ap_state state; /* State of the AP device. */
176 int pendingq_count; /* # requests on pendingq list. */
177 int requestq_count; /* # requests on requestq list. */
178 u64 total_request_count; /* # requests ever for this AP device.*/
179 int request_timeout; /* Request timeout in jiffies. */
180 struct timer_list timeout; /* Timer for request timeouts. */
181 struct list_head pendingq; /* List of message sent to AP queue. */
182 struct list_head requestq; /* List of message yet to be sent. */
183 struct ap_message *reply; /* Per device reply message. */
186 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
188 typedef enum ap_wait (ap_func_t)(struct ap_queue *queue);
191 struct list_head list; /* Request queueing. */
192 unsigned long long psmid; /* Message id. */
193 void *message; /* Pointer to message buffer. */
194 size_t length; /* Message length. */
195 int rc; /* Return code for this message */
197 void *private; /* ap driver private pointer. */
198 unsigned int special:1; /* Used for special commands. */
199 /* receive is called from tasklet context */
200 void (*receive)(struct ap_queue *, struct ap_message *,
201 struct ap_message *);
205 * ap_init_message() - Initialize ap_message.
206 * Initialize a message before using. Otherwise this might result in
207 * unexpected behaviour.
209 static inline void ap_init_message(struct ap_message *ap_msg)
211 memset(ap_msg, 0, sizeof(*ap_msg));
215 * ap_release_message() - Release ap_message.
216 * Releases all memory used internal within the ap_message struct
217 * Currently this is the message and private field.
219 static inline void ap_release_message(struct ap_message *ap_msg)
221 kzfree(ap_msg->message);
222 kzfree(ap_msg->private);
226 * Note: don't use ap_send/ap_recv after using ap_queue_message
227 * for the first time. Otherwise the ap message queue will get
230 int ap_send(ap_qid_t, unsigned long long, void *, size_t);
231 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
233 enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event);
234 enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event);
236 void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
237 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
238 void ap_flush_queue(struct ap_queue *aq);
240 void *ap_airq_ptr(void);
241 void ap_wait(enum ap_wait wait);
242 void ap_request_timeout(struct timer_list *t);
243 void ap_bus_force_rescan(void);
245 int ap_test_config_usage_domain(unsigned int domain);
246 int ap_test_config_ctrl_domain(unsigned int domain);
248 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
249 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
250 void ap_queue_prepare_remove(struct ap_queue *aq);
251 void ap_queue_remove(struct ap_queue *aq);
252 void ap_queue_init_state(struct ap_queue *aq);
254 struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type,
255 int comp_device_type, unsigned int functions);
258 unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)];
259 unsigned long apm[BITS_TO_LONGS(AP_DEVICES)];
260 unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)];
262 extern struct ap_perms ap_perms;
263 extern struct mutex ap_perms_mutex;
266 * Get ap_queue device for this qid.
267 * Returns ptr to the struct ap_queue device or NULL if there
268 * was no ap_queue device with this qid found. When something is
269 * found, the reference count of the embedded device is increased.
270 * So the caller has to decrease the reference count after use
271 * with a call to put_device(&aq->ap_dev.device).
273 struct ap_queue *ap_get_qdev(ap_qid_t qid);
276 * check APQN for owned/reserved by ap bus and default driver(s).
277 * Checks if this APQN is or will be in use by the ap bus
278 * and the default set of drivers.
279 * If yes, returns 1, if not returns 0. On error a negative
280 * errno value is returned.
282 int ap_owned_by_def_drv(int card, int queue);
285 * check 'matrix' of APQNs for owned/reserved by ap bus and
287 * Checks if there is at least one APQN in the given 'matrix'
288 * marked as owned/reserved by the ap bus and default driver(s).
289 * If such an APQN is found the return value is 1, otherwise
290 * 0 is returned. On error a negative errno value is returned.
291 * The parameter apm is a bitmask which should be declared
292 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
293 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
295 int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm,
299 * ap_parse_mask_str() - helper function to parse a bitmap string
300 * and clear/set the bits in the bitmap accordingly. The string may be
301 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple
302 * overwriting the current content of the bitmap. Or as relative string
303 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of
304 * bits are cleared or set. Distinction is done based on the very
305 * first character which may be '+' or '-' for the relative string
306 * and othewise assume to be an absolute value string. If parsing fails
307 * a negative errno value is returned. All arguments and bitmaps are
310 int ap_parse_mask_str(const char *str,
311 unsigned long *bitmap, int bits,
314 #endif /* _AP_BUS_H_ */