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