1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * Copyright IBM Corp. 2006, 2023 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_BOUND_TO_ANOTHER 0x09 52 #define AP_RESPONSE_STATE_CHANGE_IN_PROGRESS 0x0A 53 #define AP_RESPONSE_Q_NOT_BOUND 0x0B 54 #define AP_RESPONSE_Q_FULL 0x10 55 #define AP_RESPONSE_NO_PENDING_REPLY 0x10 56 #define AP_RESPONSE_INDEX_TOO_BIG 0x11 57 #define AP_RESPONSE_NO_FIRST_PART 0x13 58 #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 59 #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16 60 #define AP_RESPONSE_Q_BIND_ERROR 0x30 61 #define AP_RESPONSE_Q_NOT_AVAIL_FOR_ASSOC 0x31 62 #define AP_RESPONSE_Q_NOT_EMPTY 0x32 63 #define AP_RESPONSE_BIND_LIMIT_EXCEEDED 0x33 64 #define AP_RESPONSE_INVALID_ASSOC_SECRET 0x34 65 #define AP_RESPONSE_ASSOC_SECRET_NOT_UNIQUE 0x35 66 #define AP_RESPONSE_ASSOC_FAILED 0x36 67 #define AP_RESPONSE_INVALID_DOMAIN 0x42 68 69 /* 70 * Supported AP device types 71 */ 72 #define AP_DEVICE_TYPE_CEX4 10 73 #define AP_DEVICE_TYPE_CEX5 11 74 #define AP_DEVICE_TYPE_CEX6 12 75 #define AP_DEVICE_TYPE_CEX7 13 76 #define AP_DEVICE_TYPE_CEX8 14 77 78 /* 79 * AP queue state machine states 80 */ 81 enum ap_sm_state { 82 AP_SM_STATE_RESET_START = 0, 83 AP_SM_STATE_RESET_WAIT, 84 AP_SM_STATE_SETIRQ_WAIT, 85 AP_SM_STATE_IDLE, 86 AP_SM_STATE_WORKING, 87 AP_SM_STATE_QUEUE_FULL, 88 AP_SM_STATE_ASSOC_WAIT, 89 NR_AP_SM_STATES 90 }; 91 92 /* 93 * AP queue state machine events 94 */ 95 enum ap_sm_event { 96 AP_SM_EVENT_POLL, 97 AP_SM_EVENT_TIMEOUT, 98 NR_AP_SM_EVENTS 99 }; 100 101 /* 102 * AP queue state wait behaviour 103 */ 104 enum ap_sm_wait { 105 AP_SM_WAIT_AGAIN = 0, /* retry immediately */ 106 AP_SM_WAIT_HIGH_TIMEOUT, /* poll high freq, wait for timeout */ 107 AP_SM_WAIT_LOW_TIMEOUT, /* poll low freq, wait for timeout */ 108 AP_SM_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */ 109 AP_SM_WAIT_NONE, /* no wait */ 110 NR_AP_SM_WAIT 111 }; 112 113 /* 114 * AP queue device states 115 */ 116 enum ap_dev_state { 117 AP_DEV_STATE_UNINITIATED = 0, /* fresh and virgin, not touched */ 118 AP_DEV_STATE_OPERATING, /* queue dev is working normal */ 119 AP_DEV_STATE_SHUTDOWN, /* remove/unbind/shutdown in progress */ 120 AP_DEV_STATE_ERROR, /* device is in error state */ 121 NR_AP_DEV_STATES 122 }; 123 124 struct ap_device; 125 struct ap_message; 126 127 /* 128 * The ap driver struct includes a flags field which holds some info for 129 * the ap bus about the driver. Currently only one flag is supported and 130 * used: The DEFAULT flag marks an ap driver as a default driver which is 131 * used together with the apmask and aqmask whitelisting of the ap bus. 132 */ 133 #define AP_DRIVER_FLAG_DEFAULT 0x0001 134 135 struct ap_driver { 136 struct device_driver driver; 137 struct ap_device_id *ids; 138 unsigned int flags; 139 140 int (*probe)(struct ap_device *); 141 void (*remove)(struct ap_device *); 142 int (*in_use)(unsigned long *apm, unsigned long *aqm); 143 /* 144 * Called at the start of the ap bus scan function when 145 * the crypto config information (qci) has changed. 146 * This callback is not invoked if there is no AP 147 * QCI support available. 148 */ 149 void (*on_config_changed)(struct ap_config_info *new_config_info, 150 struct ap_config_info *old_config_info); 151 /* 152 * Called at the end of the ap bus scan function when 153 * the crypto config information (qci) has changed. 154 * This callback is not invoked if there is no AP 155 * QCI support available. 156 */ 157 void (*on_scan_complete)(struct ap_config_info *new_config_info, 158 struct ap_config_info *old_config_info); 159 }; 160 161 #define to_ap_drv(x) container_of_const((x), struct ap_driver, driver) 162 163 int ap_driver_register(struct ap_driver *, struct module *, char *); 164 void ap_driver_unregister(struct ap_driver *); 165 166 struct ap_device { 167 struct device device; 168 int device_type; /* AP device type. */ 169 }; 170 171 #define to_ap_dev(x) container_of((x), struct ap_device, device) 172 173 struct ap_card { 174 struct ap_device ap_dev; 175 struct ap_tapq_hwinfo hwinfo; /* TAPQ GR2 content */ 176 int id; /* AP card number. */ 177 unsigned int maxmsgsize; /* AP msg limit for this card */ 178 bool config; /* configured state */ 179 bool chkstop; /* checkstop state */ 180 atomic64_t total_request_count; /* # requests ever for this AP device.*/ 181 }; 182 183 #define TAPQ_CARD_HWINFO_MASK 0xFEFF0000FFFF0F0FUL 184 #define ASSOC_IDX_INVALID 0x10000 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 unsigned int se_bstate; /* SE bind state (BS) */ 198 unsigned int assoc_idx; /* SE association index */ 199 int queue_count; /* # messages currently on AP queue. */ 200 int pendingq_count; /* # requests on pendingq list. */ 201 int requestq_count; /* # requests on requestq list. */ 202 u64 total_request_count; /* # requests ever for this AP device.*/ 203 int request_timeout; /* Request timeout in jiffies. */ 204 struct timer_list timeout; /* Timer for request timeouts. */ 205 struct list_head pendingq; /* List of message sent to AP queue. */ 206 struct list_head requestq; /* List of message yet to be sent. */ 207 struct ap_message *reply; /* Per device reply message. */ 208 enum ap_sm_state sm_state; /* ap queue state machine state */ 209 int rapq_fbit; /* fbit arg for next rapq invocation */ 210 int last_err_rc; /* last error state response code */ 211 }; 212 213 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device) 214 215 typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue); 216 217 struct ap_message { 218 struct list_head list; /* Request queueing. */ 219 unsigned long psmid; /* Message id. */ 220 void *msg; /* Pointer to message buffer. */ 221 size_t len; /* actual msg len in msg buffer */ 222 size_t bufsize; /* allocated msg buffer size */ 223 u16 flags; /* Flags, see AP_MSG_FLAG_xxx */ 224 int rc; /* Return code for this message */ 225 void *private; /* ap driver private pointer. */ 226 /* receive is called from tasklet context */ 227 void (*receive)(struct ap_queue *, struct ap_message *, 228 struct ap_message *); 229 }; 230 231 #define AP_MSG_FLAG_SPECIAL 0x0001 /* flag msg as 'special' with NQAP */ 232 #define AP_MSG_FLAG_USAGE 0x0002 /* CCA, EP11: usage (no admin) msg */ 233 #define AP_MSG_FLAG_ADMIN 0x0004 /* CCA, EP11: admin (=control) msg */ 234 235 /** 236 * ap_init_message() - Initialize ap_message. 237 * Initialize a message before using. Otherwise this might result in 238 * unexpected behaviour. 239 */ 240 static inline void ap_init_message(struct ap_message *ap_msg) 241 { 242 memset(ap_msg, 0, sizeof(*ap_msg)); 243 } 244 245 /** 246 * ap_release_message() - Release ap_message. 247 * Releases all memory used internal within the ap_message struct 248 * Currently this is the message and private field. 249 */ 250 static inline void ap_release_message(struct ap_message *ap_msg) 251 { 252 kfree_sensitive(ap_msg->msg); 253 kfree_sensitive(ap_msg->private); 254 } 255 256 enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event); 257 enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event); 258 259 int ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg); 260 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg); 261 void ap_flush_queue(struct ap_queue *aq); 262 bool ap_queue_usable(struct ap_queue *aq); 263 264 void *ap_airq_ptr(void); 265 int ap_sb_available(void); 266 bool ap_is_se_guest(void); 267 void ap_wait(enum ap_sm_wait wait); 268 void ap_request_timeout(struct timer_list *t); 269 bool ap_bus_force_rescan(void); 270 271 int ap_test_config_usage_domain(unsigned int domain); 272 int ap_test_config_ctrl_domain(unsigned int domain); 273 274 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg); 275 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type); 276 void ap_queue_prepare_remove(struct ap_queue *aq); 277 void ap_queue_remove(struct ap_queue *aq); 278 void ap_queue_init_state(struct ap_queue *aq); 279 void _ap_queue_init_state(struct ap_queue *aq); 280 281 struct ap_card *ap_card_create(int id, struct ap_tapq_hwinfo info, 282 int comp_type); 283 284 #define APMASKSIZE (BITS_TO_LONGS(AP_DEVICES) * sizeof(unsigned long)) 285 #define AQMASKSIZE (BITS_TO_LONGS(AP_DOMAINS) * sizeof(unsigned long)) 286 287 struct ap_perms { 288 unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)]; 289 unsigned long apm[BITS_TO_LONGS(AP_DEVICES)]; 290 unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)]; 291 unsigned long adm[BITS_TO_LONGS(AP_DOMAINS)]; 292 }; 293 294 extern struct ap_perms ap_perms; 295 extern struct mutex ap_perms_mutex; 296 297 /* 298 * Get ap_queue device for this qid. 299 * Returns ptr to the struct ap_queue device or NULL if there 300 * was no ap_queue device with this qid found. When something is 301 * found, the reference count of the embedded device is increased. 302 * So the caller has to decrease the reference count after use 303 * with a call to put_device(&aq->ap_dev.device). 304 */ 305 struct ap_queue *ap_get_qdev(ap_qid_t qid); 306 307 /* 308 * check APQN for owned/reserved by ap bus and default driver(s). 309 * Checks if this APQN is or will be in use by the ap bus 310 * and the default set of drivers. 311 * If yes, returns 1, if not returns 0. On error a negative 312 * errno value is returned. 313 */ 314 int ap_owned_by_def_drv(int card, int queue); 315 316 /* 317 * check 'matrix' of APQNs for owned/reserved by ap bus and 318 * default driver(s). 319 * Checks if there is at least one APQN in the given 'matrix' 320 * marked as owned/reserved by the ap bus and default driver(s). 321 * If such an APQN is found the return value is 1, otherwise 322 * 0 is returned. On error a negative errno value is returned. 323 * The parameter apm is a bitmask which should be declared 324 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is 325 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS). 326 */ 327 int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm, 328 unsigned long *aqm); 329 330 /* 331 * ap_parse_mask_str() - helper function to parse a bitmap string 332 * and clear/set the bits in the bitmap accordingly. The string may be 333 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple 334 * overwriting the current content of the bitmap. Or as relative string 335 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of 336 * bits are cleared or set. Distinction is done based on the very 337 * first character which may be '+' or '-' for the relative string 338 * and otherwise assume to be an absolute value string. If parsing fails 339 * a negative errno value is returned. All arguments and bitmaps are 340 * big endian order. 341 */ 342 int ap_parse_mask_str(const char *str, 343 unsigned long *bitmap, int bits, 344 struct mutex *lock); 345 346 /* 347 * ap_hex2bitmap() - Convert a string containing a hexadecimal number (str) 348 * into a bitmap (bitmap) with bits set that correspond to the bits represented 349 * by the hex string. Input and output data is in big endian order. 350 * 351 * str - Input hex string of format "0x1234abcd". The leading "0x" is optional. 352 * At least one digit is required. Must be large enough to hold the number of 353 * bits represented by the bits parameter. 354 * 355 * bitmap - Pointer to a bitmap. Upon successful completion of this function, 356 * this bitmap will have bits set to match the value of str. If bitmap is longer 357 * than str, then the rightmost bits of bitmap are padded with zeros. Must be 358 * large enough to hold the number of bits represented by the bits parameter. 359 * 360 * bits - Length, in bits, of the bitmap represented by str. Must be a multiple 361 * of 8. 362 * 363 * Returns: 0 On success 364 * -EINVAL If str format is invalid or bits is not a multiple of 8. 365 */ 366 int ap_hex2bitmap(const char *str, unsigned long *bitmap, int bits); 367 368 /* 369 * Interface to wait for the AP bus to have done one initial ap bus 370 * scan and all detected APQNs have been bound to device drivers. 371 * If these both conditions are not fulfilled, this function blocks 372 * on a condition with wait_for_completion_killable_timeout(). 373 * If these both conditions are fulfilled (before the timeout hits) 374 * the return value is 0. If the timeout (in jiffies) hits instead 375 * -ETIME is returned. On failures negative return values are 376 * returned to the caller. 377 * It may be that the AP bus scan finds new devices. Then the 378 * condition that all APQNs are bound to their device drivers 379 * is reset to false and this call again blocks until either all 380 * APQNs are bound to a device driver or the timeout hits again. 381 */ 382 int ap_wait_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