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