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 54 /* 55 * Known device types 56 */ 57 #define AP_DEVICE_TYPE_PCICC 3 58 #define AP_DEVICE_TYPE_PCICA 4 59 #define AP_DEVICE_TYPE_PCIXCC 5 60 #define AP_DEVICE_TYPE_CEX2A 6 61 #define AP_DEVICE_TYPE_CEX2C 7 62 #define AP_DEVICE_TYPE_CEX3A 8 63 #define AP_DEVICE_TYPE_CEX3C 9 64 #define AP_DEVICE_TYPE_CEX4 10 65 #define AP_DEVICE_TYPE_CEX5 11 66 #define AP_DEVICE_TYPE_CEX6 12 67 #define AP_DEVICE_TYPE_CEX7 13 68 69 /* 70 * Known function facilities 71 */ 72 #define AP_FUNC_MEX4K 1 73 #define AP_FUNC_CRT4K 2 74 #define AP_FUNC_COPRO 3 75 #define AP_FUNC_ACCEL 4 76 #define AP_FUNC_EP11 5 77 #define AP_FUNC_APXA 6 78 79 /* 80 * AP interrupt states 81 */ 82 #define AP_INTR_DISABLED 0 /* AP interrupt disabled */ 83 #define AP_INTR_ENABLED 1 /* AP interrupt enabled */ 84 85 /* 86 * AP queue state machine states 87 */ 88 enum ap_sm_state { 89 AP_SM_STATE_RESET_START, 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 AP_SM_STATE_REMOVE, /* about to be removed from driver */ 96 AP_SM_STATE_UNBOUND, /* momentary not bound to a driver */ 97 AP_SM_STATE_BORKED, /* broken */ 98 NR_AP_SM_STATES 99 }; 100 101 /* 102 * AP queue state machine events 103 */ 104 enum ap_sm_event { 105 AP_SM_EVENT_POLL, 106 AP_SM_EVENT_TIMEOUT, 107 NR_AP_SM_EVENTS 108 }; 109 110 /* 111 * AP queue state wait behaviour 112 */ 113 enum ap_sm_wait { 114 AP_SM_WAIT_AGAIN, /* retry immediately */ 115 AP_SM_WAIT_TIMEOUT, /* wait for timeout */ 116 AP_SM_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */ 117 AP_SM_WAIT_NONE, /* no wait */ 118 NR_AP_SM_WAIT 119 }; 120 121 struct ap_device; 122 struct ap_message; 123 124 /* 125 * The ap driver struct includes a flags field which holds some info for 126 * the ap bus about the driver. Currently only one flag is supported and 127 * used: The DEFAULT flag marks an ap driver as a default driver which is 128 * used together with the apmask and aqmask whitelisting of the ap bus. 129 */ 130 #define AP_DRIVER_FLAG_DEFAULT 0x0001 131 132 struct ap_driver { 133 struct device_driver driver; 134 struct ap_device_id *ids; 135 unsigned int flags; 136 137 int (*probe)(struct ap_device *); 138 void (*remove)(struct ap_device *); 139 }; 140 141 #define to_ap_drv(x) container_of((x), struct ap_driver, driver) 142 143 int ap_driver_register(struct ap_driver *, struct module *, char *); 144 void ap_driver_unregister(struct ap_driver *); 145 146 struct ap_device { 147 struct device device; 148 struct ap_driver *drv; /* Pointer to AP device driver. */ 149 int device_type; /* AP device type. */ 150 }; 151 152 #define to_ap_dev(x) container_of((x), struct ap_device, device) 153 154 struct ap_card { 155 struct ap_device ap_dev; 156 void *private; /* ap driver private pointer. */ 157 int raw_hwtype; /* AP raw hardware type. */ 158 unsigned int functions; /* AP device function bitfield. */ 159 int queue_depth; /* AP queue depth.*/ 160 int id; /* AP card number. */ 161 atomic64_t total_request_count; /* # requests ever for this AP device.*/ 162 }; 163 164 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device) 165 166 struct ap_queue { 167 struct ap_device ap_dev; 168 struct hlist_node hnode; /* Node for the ap_queues hashtable */ 169 struct ap_card *card; /* Ptr to assoc. AP card. */ 170 spinlock_t lock; /* Per device lock. */ 171 void *private; /* ap driver private pointer. */ 172 ap_qid_t qid; /* AP queue id. */ 173 int interrupt; /* indicate if interrupts are enabled */ 174 int queue_count; /* # messages currently on AP queue. */ 175 enum ap_sm_state sm_state; /* ap queue state machine state */ 176 int pendingq_count; /* # requests on pendingq list. */ 177 int requestq_count; /* # requests on requestq list. */ 178 u64 total_request_count; /* # requests ever for this AP device.*/ 179 int request_timeout; /* Request timeout in jiffies. */ 180 struct timer_list timeout; /* Timer for request timeouts. */ 181 struct list_head pendingq; /* List of message sent to AP queue. */ 182 struct list_head requestq; /* List of message yet to be sent. */ 183 struct ap_message *reply; /* Per device reply message. */ 184 }; 185 186 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device) 187 188 typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue); 189 190 struct ap_message { 191 struct list_head list; /* Request queueing. */ 192 unsigned long long psmid; /* Message id. */ 193 void *msg; /* Pointer to message buffer. */ 194 unsigned int len; /* Message length. */ 195 u32 flags; /* Flags, see AP_MSG_FLAG_xxx */ 196 int rc; /* Return code for this message */ 197 void *private; /* ap driver private pointer. */ 198 /* receive is called from tasklet context */ 199 void (*receive)(struct ap_queue *, struct ap_message *, 200 struct ap_message *); 201 }; 202 203 #define AP_MSG_FLAG_SPECIAL (1 << 16) /* flag msg as 'special' with NQAP */ 204 205 /** 206 * ap_init_message() - Initialize ap_message. 207 * Initialize a message before using. Otherwise this might result in 208 * unexpected behaviour. 209 */ 210 static inline void ap_init_message(struct ap_message *ap_msg) 211 { 212 memset(ap_msg, 0, sizeof(*ap_msg)); 213 } 214 215 /** 216 * ap_release_message() - Release ap_message. 217 * Releases all memory used internal within the ap_message struct 218 * Currently this is the message and private field. 219 */ 220 static inline void ap_release_message(struct ap_message *ap_msg) 221 { 222 kfree_sensitive(ap_msg->msg); 223 kfree_sensitive(ap_msg->private); 224 } 225 226 /* 227 * Note: don't use ap_send/ap_recv after using ap_queue_message 228 * for the first time. Otherwise the ap message queue will get 229 * confused. 230 */ 231 int ap_send(ap_qid_t, unsigned long long, void *, size_t); 232 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 233 234 enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event); 235 enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event); 236 237 void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg); 238 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg); 239 void ap_flush_queue(struct ap_queue *aq); 240 241 void *ap_airq_ptr(void); 242 void ap_wait(enum ap_sm_wait wait); 243 void ap_request_timeout(struct timer_list *t); 244 void ap_bus_force_rescan(void); 245 246 int ap_test_config_usage_domain(unsigned int domain); 247 int ap_test_config_ctrl_domain(unsigned int domain); 248 249 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg); 250 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type); 251 void ap_queue_prepare_remove(struct ap_queue *aq); 252 void ap_queue_remove(struct ap_queue *aq); 253 void ap_queue_init_state(struct ap_queue *aq); 254 255 struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type, 256 int comp_device_type, unsigned int functions); 257 258 struct ap_perms { 259 unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)]; 260 unsigned long apm[BITS_TO_LONGS(AP_DEVICES)]; 261 unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)]; 262 }; 263 extern struct ap_perms ap_perms; 264 extern struct mutex ap_perms_mutex; 265 266 /* 267 * Get ap_queue device for this qid. 268 * Returns ptr to the struct ap_queue device or NULL if there 269 * was no ap_queue device with this qid found. When something is 270 * found, the reference count of the embedded device is increased. 271 * So the caller has to decrease the reference count after use 272 * with a call to put_device(&aq->ap_dev.device). 273 */ 274 struct ap_queue *ap_get_qdev(ap_qid_t qid); 275 276 /* 277 * check APQN for owned/reserved by ap bus and default driver(s). 278 * Checks if this APQN is or will be in use by the ap bus 279 * and the default set of drivers. 280 * If yes, returns 1, if not returns 0. On error a negative 281 * errno value is returned. 282 */ 283 int ap_owned_by_def_drv(int card, int queue); 284 285 /* 286 * check 'matrix' of APQNs for owned/reserved by ap bus and 287 * default driver(s). 288 * Checks if there is at least one APQN in the given 'matrix' 289 * marked as owned/reserved by the ap bus and default driver(s). 290 * If such an APQN is found the return value is 1, otherwise 291 * 0 is returned. On error a negative errno value is returned. 292 * The parameter apm is a bitmask which should be declared 293 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is 294 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS). 295 */ 296 int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm, 297 unsigned long *aqm); 298 299 /* 300 * ap_parse_mask_str() - helper function to parse a bitmap string 301 * and clear/set the bits in the bitmap accordingly. The string may be 302 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple 303 * overwriting the current content of the bitmap. Or as relative string 304 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of 305 * bits are cleared or set. Distinction is done based on the very 306 * first character which may be '+' or '-' for the relative string 307 * and othewise assume to be an absolute value string. If parsing fails 308 * a negative errno value is returned. All arguments and bitmaps are 309 * big endian order. 310 */ 311 int ap_parse_mask_str(const char *str, 312 unsigned long *bitmap, int bits, 313 struct mutex *lock); 314 315 #endif /* _AP_BUS_H_ */ 316