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