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