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