1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright IBM Corp. 2006, 2012
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_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */
24 #define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */
25 #define AP_POLL_TIME 1 /* Time in ticks between receive polls. */
27 extern int ap_domain_index;
29 extern spinlock_t ap_list_lock;
30 extern struct list_head ap_card_list;
32 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
34 return (*ptr & (0x80000000u >> nr)) != 0;
37 #define AP_RESPONSE_NORMAL 0x00
38 #define AP_RESPONSE_Q_NOT_AVAIL 0x01
39 #define AP_RESPONSE_RESET_IN_PROGRESS 0x02
40 #define AP_RESPONSE_DECONFIGURED 0x03
41 #define AP_RESPONSE_CHECKSTOPPED 0x04
42 #define AP_RESPONSE_BUSY 0x05
43 #define AP_RESPONSE_INVALID_ADDRESS 0x06
44 #define AP_RESPONSE_OTHERWISE_CHANGED 0x07
45 #define AP_RESPONSE_Q_FULL 0x10
46 #define AP_RESPONSE_NO_PENDING_REPLY 0x10
47 #define AP_RESPONSE_INDEX_TOO_BIG 0x11
48 #define AP_RESPONSE_NO_FIRST_PART 0x13
49 #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15
50 #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16
55 #define AP_DEVICE_TYPE_PCICC 3
56 #define AP_DEVICE_TYPE_PCICA 4
57 #define AP_DEVICE_TYPE_PCIXCC 5
58 #define AP_DEVICE_TYPE_CEX2A 6
59 #define AP_DEVICE_TYPE_CEX2C 7
60 #define AP_DEVICE_TYPE_CEX3A 8
61 #define AP_DEVICE_TYPE_CEX3C 9
62 #define AP_DEVICE_TYPE_CEX4 10
63 #define AP_DEVICE_TYPE_CEX5 11
64 #define AP_DEVICE_TYPE_CEX6 12
67 * Known function facilities
69 #define AP_FUNC_MEX4K 1
70 #define AP_FUNC_CRT4K 2
71 #define AP_FUNC_COPRO 3
72 #define AP_FUNC_ACCEL 4
73 #define AP_FUNC_EP11 5
74 #define AP_FUNC_APXA 6
79 #define AP_INTR_DISABLED 0 /* AP interrupt disabled */
80 #define AP_INTR_ENABLED 1 /* AP interrupt enabled */
92 AP_STATE_SUSPEND_WAIT,
110 AP_WAIT_AGAIN, /* retry immediately */
111 AP_WAIT_TIMEOUT, /* wait for timeout */
112 AP_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */
113 AP_WAIT_NONE, /* no wait */
121 struct device_driver driver;
122 struct ap_device_id *ids;
124 int (*probe)(struct ap_device *);
125 void (*remove)(struct ap_device *);
126 void (*suspend)(struct ap_device *);
127 void (*resume)(struct ap_device *);
130 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
132 int ap_driver_register(struct ap_driver *, struct module *, char *);
133 void ap_driver_unregister(struct ap_driver *);
136 struct device device;
137 struct ap_driver *drv; /* Pointer to AP device driver. */
138 int device_type; /* AP device type. */
141 #define to_ap_dev(x) container_of((x), struct ap_device, device)
144 struct ap_device ap_dev;
145 struct list_head list; /* Private list of AP cards. */
146 struct list_head queues; /* List of assoc. AP queues */
147 void *private; /* ap driver private pointer. */
148 int raw_hwtype; /* AP raw hardware type. */
149 unsigned int functions; /* AP device function bitfield. */
150 int queue_depth; /* AP queue depth.*/
151 int id; /* AP card number. */
152 atomic_t total_request_count; /* # requests ever for this AP device.*/
155 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
158 struct ap_device ap_dev;
159 struct list_head list; /* Private list of AP queues. */
160 struct ap_card *card; /* Ptr to assoc. AP card. */
161 spinlock_t lock; /* Per device lock. */
162 void *private; /* ap driver private pointer. */
163 ap_qid_t qid; /* AP queue id. */
164 int interrupt; /* indicate if interrupts are enabled */
165 int queue_count; /* # messages currently on AP queue. */
166 enum ap_state state; /* State of the AP device. */
167 int pendingq_count; /* # requests on pendingq list. */
168 int requestq_count; /* # requests on requestq list. */
169 int total_request_count; /* # requests ever for this AP device.*/
170 int request_timeout; /* Request timout in jiffies. */
171 struct timer_list timeout; /* Timer for request timeouts. */
172 struct list_head pendingq; /* List of message sent to AP queue. */
173 struct list_head requestq; /* List of message yet to be sent. */
174 struct ap_message *reply; /* Per device reply message. */
177 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
179 typedef enum ap_wait (ap_func_t)(struct ap_queue *queue);
182 struct list_head list; /* Request queueing. */
183 unsigned long long psmid; /* Message id. */
184 void *message; /* Pointer to message buffer. */
185 size_t length; /* Message length. */
186 int rc; /* Return code for this message */
188 void *private; /* ap driver private pointer. */
189 unsigned int special:1; /* Used for special commands. */
190 /* receive is called from tasklet context */
191 void (*receive)(struct ap_queue *, struct ap_message *,
192 struct ap_message *);
196 * ap_init_message() - Initialize ap_message.
197 * Initialize a message before using. Otherwise this might result in
198 * unexpected behaviour.
200 static inline void ap_init_message(struct ap_message *ap_msg)
202 memset(ap_msg, 0, sizeof(*ap_msg));
206 * ap_release_message() - Release ap_message.
207 * Releases all memory used internal within the ap_message struct
208 * Currently this is the message and private field.
210 static inline void ap_release_message(struct ap_message *ap_msg)
212 kzfree(ap_msg->message);
213 kzfree(ap_msg->private);
216 #define for_each_ap_card(_ac) \
217 list_for_each_entry(_ac, &ap_card_list, list)
219 #define for_each_ap_queue(_aq, _ac) \
220 list_for_each_entry(_aq, &(_ac)->queues, list)
223 * Note: don't use ap_send/ap_recv after using ap_queue_message
224 * for the first time. Otherwise the ap message queue will get
227 int ap_send(ap_qid_t, unsigned long long, void *, size_t);
228 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
230 enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event);
231 enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event);
233 void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
234 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
235 void ap_flush_queue(struct ap_queue *aq);
237 void *ap_airq_ptr(void);
238 void ap_wait(enum ap_wait wait);
239 void ap_request_timeout(struct timer_list *t);
240 void ap_bus_force_rescan(void);
242 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
243 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
244 void ap_queue_remove(struct ap_queue *aq);
245 void ap_queue_suspend(struct ap_device *ap_dev);
246 void ap_queue_resume(struct ap_device *ap_dev);
248 struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type,
249 int comp_device_type, unsigned int functions);
251 #endif /* _AP_BUS_H_ */