1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 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> 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 <linux/hashtable.h> 19 #include <asm/isc.h> 20 #include <asm/ap.h> 21 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. */ 28 29 extern int ap_domain_index; 30 31 extern DECLARE_HASHTABLE(ap_queues, 8); 32 extern spinlock_t ap_queues_lock; 33 34 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr) 35 { 36 return (*ptr & (0x80000000u >> nr)) != 0; 37 } 38 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 53 #define AP_RESPONSE_INVALID_DOMAIN 0x42 54 55 /* 56 * Known device types 57 */ 58 #define AP_DEVICE_TYPE_PCICC 3 59 #define AP_DEVICE_TYPE_PCICA 4 60 #define AP_DEVICE_TYPE_PCIXCC 5 61 #define AP_DEVICE_TYPE_CEX2A 6 62 #define AP_DEVICE_TYPE_CEX2C 7 63 #define AP_DEVICE_TYPE_CEX3A 8 64 #define AP_DEVICE_TYPE_CEX3C 9 65 #define AP_DEVICE_TYPE_CEX4 10 66 #define AP_DEVICE_TYPE_CEX5 11 67 #define AP_DEVICE_TYPE_CEX6 12 68 #define AP_DEVICE_TYPE_CEX7 13 69 70 /* 71 * Known function facilities 72 */ 73 #define AP_FUNC_MEX4K 1 74 #define AP_FUNC_CRT4K 2 75 #define AP_FUNC_COPRO 3 76 #define AP_FUNC_ACCEL 4 77 #define AP_FUNC_EP11 5 78 #define AP_FUNC_APXA 6 79 80 /* 81 * AP interrupt states 82 */ 83 #define AP_INTR_DISABLED 0 /* AP interrupt disabled */ 84 #define AP_INTR_ENABLED 1 /* AP interrupt enabled */ 85 86 /* 87 * AP queue state machine states 88 */ 89 enum ap_sm_state { 90 AP_SM_STATE_RESET_START = 0, 91 AP_SM_STATE_RESET_WAIT, 92 AP_SM_STATE_SETIRQ_WAIT, 93 AP_SM_STATE_IDLE, 94 AP_SM_STATE_WORKING, 95 AP_SM_STATE_QUEUE_FULL, 96 NR_AP_SM_STATES 97 }; 98 99 /* 100 * AP queue state machine events 101 */ 102 enum ap_sm_event { 103 AP_SM_EVENT_POLL, 104 AP_SM_EVENT_TIMEOUT, 105 NR_AP_SM_EVENTS 106 }; 107 108 /* 109 * AP queue state wait behaviour 110 */ 111 enum ap_sm_wait { 112 AP_SM_WAIT_AGAIN, /* retry immediately */ 113 AP_SM_WAIT_TIMEOUT, /* wait for timeout */ 114 AP_SM_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */ 115 AP_SM_WAIT_NONE, /* no wait */ 116 NR_AP_SM_WAIT 117 }; 118 119 /* 120 * AP queue device states 121 */ 122 enum ap_dev_state { 123 AP_DEV_STATE_UNINITIATED = 0, /* fresh and virgin, not touched */ 124 AP_DEV_STATE_OPERATING, /* queue dev is working normal */ 125 AP_DEV_STATE_SHUTDOWN, /* remove/unbind/shutdown in progress */ 126 AP_DEV_STATE_ERROR, /* device is in error state */ 127 NR_AP_DEV_STATES 128 }; 129 130 struct ap_device; 131 struct ap_message; 132 133 /* 134 * The ap driver struct includes a flags field which holds some info for 135 * the ap bus about the driver. Currently only one flag is supported and 136 * used: The DEFAULT flag marks an ap driver as a default driver which is 137 * used together with the apmask and aqmask whitelisting of the ap bus. 138 */ 139 #define AP_DRIVER_FLAG_DEFAULT 0x0001 140 141 struct ap_driver { 142 struct device_driver driver; 143 struct ap_device_id *ids; 144 unsigned int flags; 145 146 int (*probe)(struct ap_device *); 147 void (*remove)(struct ap_device *); 148 }; 149 150 #define to_ap_drv(x) container_of((x), struct ap_driver, driver) 151 152 int ap_driver_register(struct ap_driver *, struct module *, char *); 153 void ap_driver_unregister(struct ap_driver *); 154 155 struct ap_device { 156 struct device device; 157 struct ap_driver *drv; /* Pointer to AP device driver. */ 158 int device_type; /* AP device type. */ 159 }; 160 161 #define to_ap_dev(x) container_of((x), struct ap_device, device) 162 163 struct ap_card { 164 struct ap_device ap_dev; 165 void *private; /* ap driver private pointer. */ 166 int raw_hwtype; /* AP raw hardware type. */ 167 unsigned int functions; /* AP device function bitfield. */ 168 int queue_depth; /* AP queue depth.*/ 169 int id; /* AP card number. */ 170 bool config; /* configured state */ 171 atomic64_t total_request_count; /* # requests ever for this AP device.*/ 172 }; 173 174 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device) 175 176 struct ap_queue { 177 struct ap_device ap_dev; 178 struct hlist_node hnode; /* Node for the ap_queues hashtable */ 179 struct ap_card *card; /* Ptr to assoc. AP card. */ 180 spinlock_t lock; /* Per device lock. */ 181 void *private; /* ap driver private pointer. */ 182 enum ap_dev_state dev_state; /* queue device state */ 183 bool config; /* configured state */ 184 ap_qid_t qid; /* AP queue id. */ 185 int interrupt; /* indicate if interrupts are enabled */ 186 int queue_count; /* # messages currently on AP queue. */ 187 int pendingq_count; /* # requests on pendingq list. */ 188 int requestq_count; /* # requests on requestq list. */ 189 u64 total_request_count; /* # requests ever for this AP device.*/ 190 int request_timeout; /* Request timeout in jiffies. */ 191 struct timer_list timeout; /* Timer for request timeouts. */ 192 struct list_head pendingq; /* List of message sent to AP queue. */ 193 struct list_head requestq; /* List of message yet to be sent. */ 194 struct ap_message *reply; /* Per device reply message. */ 195 enum ap_sm_state sm_state; /* ap queue state machine state */ 196 int last_err_rc; /* last error state response code */ 197 }; 198 199 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device) 200 201 typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue); 202 203 /* failure injection cmd struct */ 204 struct ap_fi { 205 union { 206 u16 cmd; /* fi flags + action */ 207 struct { 208 u8 flags; /* fi flags only */ 209 u8 action; /* fi action only */ 210 }; 211 }; 212 }; 213 214 /* all currently known fi actions */ 215 enum ap_fi_actions { 216 AP_FI_ACTION_CCA_AGENT_FF = 0x01, 217 AP_FI_ACTION_CCA_DOM_INVAL = 0x02, 218 AP_FI_ACTION_NQAP_QID_INVAL = 0x03, 219 }; 220 221 /* all currently known fi flags */ 222 enum ap_fi_flags { 223 AP_FI_FLAG_NO_RETRY = 0x01, 224 AP_FI_FLAG_TOGGLE_SPECIAL = 0x02, 225 }; 226 227 struct ap_message { 228 struct list_head list; /* Request queueing. */ 229 unsigned long long psmid; /* Message id. */ 230 void *msg; /* Pointer to message buffer. */ 231 unsigned int len; /* Message length. */ 232 u16 flags; /* Flags, see AP_MSG_FLAG_xxx */ 233 struct ap_fi fi; /* Failure Injection cmd */ 234 int rc; /* Return code for this message */ 235 void *private; /* ap driver private pointer. */ 236 /* receive is called from tasklet context */ 237 void (*receive)(struct ap_queue *, struct ap_message *, 238 struct ap_message *); 239 }; 240 241 #define AP_MSG_FLAG_SPECIAL 1 /* flag msg as 'special' with NQAP */ 242 243 /** 244 * ap_init_message() - Initialize ap_message. 245 * Initialize a message before using. Otherwise this might result in 246 * unexpected behaviour. 247 */ 248 static inline void ap_init_message(struct ap_message *ap_msg) 249 { 250 memset(ap_msg, 0, sizeof(*ap_msg)); 251 } 252 253 /** 254 * ap_release_message() - Release ap_message. 255 * Releases all memory used internal within the ap_message struct 256 * Currently this is the message and private field. 257 */ 258 static inline void ap_release_message(struct ap_message *ap_msg) 259 { 260 kfree_sensitive(ap_msg->msg); 261 kfree_sensitive(ap_msg->private); 262 } 263 264 /* 265 * Note: don't use ap_send/ap_recv after using ap_queue_message 266 * for the first time. Otherwise the ap message queue will get 267 * confused. 268 */ 269 int ap_send(ap_qid_t, unsigned long long, void *, size_t); 270 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 271 272 enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event); 273 enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event); 274 275 int ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg); 276 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg); 277 void ap_flush_queue(struct ap_queue *aq); 278 279 void *ap_airq_ptr(void); 280 void ap_wait(enum ap_sm_wait wait); 281 void ap_request_timeout(struct timer_list *t); 282 void ap_bus_force_rescan(void); 283 284 int ap_test_config_usage_domain(unsigned int domain); 285 int ap_test_config_ctrl_domain(unsigned int domain); 286 287 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg); 288 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type); 289 void ap_queue_prepare_remove(struct ap_queue *aq); 290 void ap_queue_remove(struct ap_queue *aq); 291 void ap_queue_init_state(struct ap_queue *aq); 292 293 struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type, 294 int comp_device_type, unsigned int functions); 295 296 struct ap_perms { 297 unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)]; 298 unsigned long apm[BITS_TO_LONGS(AP_DEVICES)]; 299 unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)]; 300 }; 301 extern struct ap_perms ap_perms; 302 extern struct mutex ap_perms_mutex; 303 304 /* 305 * Get ap_queue device for this qid. 306 * Returns ptr to the struct ap_queue device or NULL if there 307 * was no ap_queue device with this qid found. When something is 308 * found, the reference count of the embedded device is increased. 309 * So the caller has to decrease the reference count after use 310 * with a call to put_device(&aq->ap_dev.device). 311 */ 312 struct ap_queue *ap_get_qdev(ap_qid_t qid); 313 314 /* 315 * check APQN for owned/reserved by ap bus and default driver(s). 316 * Checks if this APQN is or will be in use by the ap bus 317 * and the default set of drivers. 318 * If yes, returns 1, if not returns 0. On error a negative 319 * errno value is returned. 320 */ 321 int ap_owned_by_def_drv(int card, int queue); 322 323 /* 324 * check 'matrix' of APQNs for owned/reserved by ap bus and 325 * default driver(s). 326 * Checks if there is at least one APQN in the given 'matrix' 327 * marked as owned/reserved by the ap bus and default driver(s). 328 * If such an APQN is found the return value is 1, otherwise 329 * 0 is returned. On error a negative errno value is returned. 330 * The parameter apm is a bitmask which should be declared 331 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is 332 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS). 333 */ 334 int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm, 335 unsigned long *aqm); 336 337 /* 338 * ap_parse_mask_str() - helper function to parse a bitmap string 339 * and clear/set the bits in the bitmap accordingly. The string may be 340 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple 341 * overwriting the current content of the bitmap. Or as relative string 342 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of 343 * bits are cleared or set. Distinction is done based on the very 344 * first character which may be '+' or '-' for the relative string 345 * and othewise assume to be an absolute value string. If parsing fails 346 * a negative errno value is returned. All arguments and bitmaps are 347 * big endian order. 348 */ 349 int ap_parse_mask_str(const char *str, 350 unsigned long *bitmap, int bits, 351 struct mutex *lock); 352 353 /* 354 * Interface to wait for the AP bus to have done one initial ap bus 355 * scan and all detected APQNs have been bound to device drivers. 356 * If these both conditions are not fulfilled, this function blocks 357 * on a condition with wait_for_completion_killable_timeout(). 358 * If these both conditions are fulfilled (before the timeout hits) 359 * the return value is 0. If the timeout (in jiffies) hits instead 360 * -ETIME is returned. On failures negative return values are 361 * returned to the caller. 362 */ 363 int ap_wait_init_apqn_bindings_complete(unsigned long timeout); 364 365 #endif /* _AP_BUS_H_ */ 366