1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 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> 9 * 10 * Adjunct processor bus header file. 11 */ 12 13 #ifndef _AP_BUS_H_ 14 #define _AP_BUS_H_ 15 16 #include <linux/device.h> 17 #include <linux/types.h> 18 #include <asm/isc.h> 19 #include <asm/ap.h> 20 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. */ 27 28 extern int ap_domain_index; 29 30 extern spinlock_t ap_list_lock; 31 extern struct list_head ap_card_list; 32 33 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr) 34 { 35 return (*ptr & (0x80000000u >> nr)) != 0; 36 } 37 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 52 53 /* 54 * Known device types 55 */ 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 67 /* 68 * Known function facilities 69 */ 70 #define AP_FUNC_MEX4K 1 71 #define AP_FUNC_CRT4K 2 72 #define AP_FUNC_COPRO 3 73 #define AP_FUNC_ACCEL 4 74 #define AP_FUNC_EP11 5 75 #define AP_FUNC_APXA 6 76 77 /* 78 * AP interrupt states 79 */ 80 #define AP_INTR_DISABLED 0 /* AP interrupt disabled */ 81 #define AP_INTR_ENABLED 1 /* AP interrupt enabled */ 82 83 /* 84 * AP device states 85 */ 86 enum ap_state { 87 AP_STATE_RESET_START, 88 AP_STATE_RESET_WAIT, 89 AP_STATE_SETIRQ_WAIT, 90 AP_STATE_IDLE, 91 AP_STATE_WORKING, 92 AP_STATE_QUEUE_FULL, 93 AP_STATE_SUSPEND_WAIT, 94 AP_STATE_UNBOUND, /* momentary not bound to a driver */ 95 AP_STATE_BORKED, /* broken */ 96 NR_AP_STATES 97 }; 98 99 /* 100 * AP device events 101 */ 102 enum ap_event { 103 AP_EVENT_POLL, 104 AP_EVENT_TIMEOUT, 105 NR_AP_EVENTS 106 }; 107 108 /* 109 * AP wait behaviour 110 */ 111 enum ap_wait { 112 AP_WAIT_AGAIN, /* retry immediately */ 113 AP_WAIT_TIMEOUT, /* wait for timeout */ 114 AP_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */ 115 AP_WAIT_NONE, /* no wait */ 116 NR_AP_WAIT 117 }; 118 119 struct ap_device; 120 struct ap_message; 121 122 /* 123 * The ap driver struct includes a flags field which holds some info for 124 * the ap bus about the driver. Currently only one flag is supported and 125 * used: The DEFAULT flag marks an ap driver as a default driver which is 126 * used together with the apmask and aqmask whitelisting of the ap bus. 127 */ 128 #define AP_DRIVER_FLAG_DEFAULT 0x0001 129 130 struct ap_driver { 131 struct device_driver driver; 132 struct ap_device_id *ids; 133 unsigned int flags; 134 135 int (*probe)(struct ap_device *); 136 void (*remove)(struct ap_device *); 137 void (*suspend)(struct ap_device *); 138 void (*resume)(struct ap_device *); 139 }; 140 141 #define to_ap_drv(x) container_of((x), struct ap_driver, driver) 142 143 int ap_driver_register(struct ap_driver *, struct module *, char *); 144 void ap_driver_unregister(struct ap_driver *); 145 146 struct ap_device { 147 struct device device; 148 struct ap_driver *drv; /* Pointer to AP device driver. */ 149 int device_type; /* AP device type. */ 150 }; 151 152 #define to_ap_dev(x) container_of((x), struct ap_device, device) 153 154 struct ap_card { 155 struct ap_device ap_dev; 156 struct list_head list; /* Private list of AP cards. */ 157 struct list_head queues; /* List of assoc. AP queues */ 158 void *private; /* ap driver private pointer. */ 159 int raw_hwtype; /* AP raw hardware type. */ 160 unsigned int functions; /* AP device function bitfield. */ 161 int queue_depth; /* AP queue depth.*/ 162 int id; /* AP card number. */ 163 atomic_t total_request_count; /* # requests ever for this AP device.*/ 164 }; 165 166 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device) 167 168 struct ap_queue { 169 struct ap_device ap_dev; 170 struct list_head list; /* Private list of AP queues. */ 171 struct ap_card *card; /* Ptr to assoc. AP card. */ 172 spinlock_t lock; /* Per device lock. */ 173 void *private; /* ap driver private pointer. */ 174 ap_qid_t qid; /* AP queue id. */ 175 int interrupt; /* indicate if interrupts are enabled */ 176 int queue_count; /* # messages currently on AP queue. */ 177 enum ap_state state; /* State of the AP device. */ 178 int pendingq_count; /* # requests on pendingq list. */ 179 int requestq_count; /* # requests on requestq list. */ 180 int total_request_count; /* # requests ever for this AP device.*/ 181 int request_timeout; /* Request timeout in jiffies. */ 182 struct timer_list timeout; /* Timer for request timeouts. */ 183 struct list_head pendingq; /* List of message sent to AP queue. */ 184 struct list_head requestq; /* List of message yet to be sent. */ 185 struct ap_message *reply; /* Per device reply message. */ 186 }; 187 188 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device) 189 190 typedef enum ap_wait (ap_func_t)(struct ap_queue *queue); 191 192 struct ap_message { 193 struct list_head list; /* Request queueing. */ 194 unsigned long long psmid; /* Message id. */ 195 void *message; /* Pointer to message buffer. */ 196 size_t length; /* Message length. */ 197 int rc; /* Return code for this message */ 198 199 void *private; /* ap driver private pointer. */ 200 unsigned int special:1; /* Used for special commands. */ 201 /* receive is called from tasklet context */ 202 void (*receive)(struct ap_queue *, struct ap_message *, 203 struct ap_message *); 204 }; 205 206 /** 207 * ap_init_message() - Initialize ap_message. 208 * Initialize a message before using. Otherwise this might result in 209 * unexpected behaviour. 210 */ 211 static inline void ap_init_message(struct ap_message *ap_msg) 212 { 213 memset(ap_msg, 0, sizeof(*ap_msg)); 214 } 215 216 /** 217 * ap_release_message() - Release ap_message. 218 * Releases all memory used internal within the ap_message struct 219 * Currently this is the message and private field. 220 */ 221 static inline void ap_release_message(struct ap_message *ap_msg) 222 { 223 kzfree(ap_msg->message); 224 kzfree(ap_msg->private); 225 } 226 227 #define for_each_ap_card(_ac) \ 228 list_for_each_entry(_ac, &ap_card_list, list) 229 230 #define for_each_ap_queue(_aq, _ac) \ 231 list_for_each_entry(_aq, &(_ac)->queues, list) 232 233 /* 234 * Note: don't use ap_send/ap_recv after using ap_queue_message 235 * for the first time. Otherwise the ap message queue will get 236 * confused. 237 */ 238 int ap_send(ap_qid_t, unsigned long long, void *, size_t); 239 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 240 241 enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event); 242 enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event); 243 244 void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg); 245 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg); 246 void ap_flush_queue(struct ap_queue *aq); 247 248 void *ap_airq_ptr(void); 249 void ap_wait(enum ap_wait wait); 250 void ap_request_timeout(struct timer_list *t); 251 void ap_bus_force_rescan(void); 252 253 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg); 254 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type); 255 void ap_queue_remove(struct ap_queue *aq); 256 void ap_queue_suspend(struct ap_device *ap_dev); 257 void ap_queue_resume(struct ap_device *ap_dev); 258 void ap_queue_reinit_state(struct ap_queue *aq); 259 260 struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type, 261 int comp_device_type, unsigned int functions); 262 263 struct ap_perms { 264 unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)]; 265 unsigned long apm[BITS_TO_LONGS(AP_DEVICES)]; 266 unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)]; 267 }; 268 extern struct ap_perms ap_perms; 269 extern struct mutex ap_perms_mutex; 270 271 /* 272 * check APQN for owned/reserved by ap bus and default driver(s). 273 * Checks if this APQN is or will be in use by the ap bus 274 * and the default set of drivers. 275 * If yes, returns 1, if not returns 0. On error a negative 276 * errno value is returned. 277 */ 278 int ap_owned_by_def_drv(int card, int queue); 279 280 /* 281 * check 'matrix' of APQNs for owned/reserved by ap bus and 282 * default driver(s). 283 * Checks if there is at least one APQN in the given 'matrix' 284 * marked as owned/reserved by the ap bus and default driver(s). 285 * If such an APQN is found the return value is 1, otherwise 286 * 0 is returned. On error a negative errno value is returned. 287 * The parameter apm is a bitmask which should be declared 288 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is 289 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS). 290 */ 291 int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm, 292 unsigned long *aqm); 293 294 /* 295 * ap_parse_mask_str() - helper function to parse a bitmap string 296 * and clear/set the bits in the bitmap accordingly. The string may be 297 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple 298 * overwriting the current content of the bitmap. Or as relative string 299 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of 300 * bits are cleared or set. Distinction is done based on the very 301 * first character which may be '+' or '-' for the relative string 302 * and othewise assume to be an absolute value string. If parsing fails 303 * a negative errno value is returned. All arguments and bitmaps are 304 * big endian order. 305 */ 306 int ap_parse_mask_str(const char *str, 307 unsigned long *bitmap, int bits, 308 struct mutex *lock); 309 310 #endif /* _AP_BUS_H_ */ 311