1ac2b96f3SHarald Freudenberger /* SPDX-License-Identifier: GPL-2.0+ */ 21534c382SMartin Schwidefsky /* 375014550SHolger Dengler * Copyright IBM Corp. 2006, 2012 41534c382SMartin Schwidefsky * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com> 51534c382SMartin Schwidefsky * Martin Schwidefsky <schwidefsky@de.ibm.com> 61534c382SMartin Schwidefsky * Ralph Wuerthner <rwuerthn@de.ibm.com> 7cb17a636SFelix Beck * Felix Beck <felix.beck@de.ibm.com> 86bed05bcSHolger Dengler * Holger Dengler <hd@linux.vnet.ibm.com> 91534c382SMartin Schwidefsky * 101534c382SMartin Schwidefsky * Adjunct processor bus header file. 111534c382SMartin Schwidefsky */ 121534c382SMartin Schwidefsky 131534c382SMartin Schwidefsky #ifndef _AP_BUS_H_ 141534c382SMartin Schwidefsky #define _AP_BUS_H_ 151534c382SMartin Schwidefsky 161534c382SMartin Schwidefsky #include <linux/device.h> 171534c382SMartin Schwidefsky #include <linux/types.h> 18f1b0a434SHarald Freudenberger #include <asm/isc.h> 19e7fc5146STony Krowiak #include <asm/ap.h> 201534c382SMartin Schwidefsky 21af4a7227SHarald Freudenberger #define AP_DEVICES 256 /* Number of AP devices. */ 22170387a8SIngo Tuchscherer #define AP_DOMAINS 256 /* Number of AP domains. */ 2300fab235SHarald Freudenberger #define AP_IOCTLS 256 /* Number of ioctls. */ 2491f3e3eaSIngo Tuchscherer #define AP_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */ 251534c382SMartin Schwidefsky #define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */ 261534c382SMartin Schwidefsky #define AP_POLL_TIME 1 /* Time in ticks between receive polls. */ 271534c382SMartin Schwidefsky 281534c382SMartin Schwidefsky extern int ap_domain_index; 291534c382SMartin Schwidefsky 30e28d2af4SIngo Tuchscherer extern spinlock_t ap_list_lock; 31e28d2af4SIngo Tuchscherer extern struct list_head ap_card_list; 32e28d2af4SIngo Tuchscherer 3375014550SHolger Dengler static inline int ap_test_bit(unsigned int *ptr, unsigned int nr) 346bed05bcSHolger Dengler { 3575014550SHolger Dengler return (*ptr & (0x80000000u >> nr)) != 0; 366bed05bcSHolger Dengler } 371534c382SMartin Schwidefsky 381534c382SMartin Schwidefsky #define AP_RESPONSE_NORMAL 0x00 391534c382SMartin Schwidefsky #define AP_RESPONSE_Q_NOT_AVAIL 0x01 401534c382SMartin Schwidefsky #define AP_RESPONSE_RESET_IN_PROGRESS 0x02 411534c382SMartin Schwidefsky #define AP_RESPONSE_DECONFIGURED 0x03 421534c382SMartin Schwidefsky #define AP_RESPONSE_CHECKSTOPPED 0x04 431534c382SMartin Schwidefsky #define AP_RESPONSE_BUSY 0x05 44cb17a636SFelix Beck #define AP_RESPONSE_INVALID_ADDRESS 0x06 45cb17a636SFelix Beck #define AP_RESPONSE_OTHERWISE_CHANGED 0x07 461534c382SMartin Schwidefsky #define AP_RESPONSE_Q_FULL 0x10 471534c382SMartin Schwidefsky #define AP_RESPONSE_NO_PENDING_REPLY 0x10 481534c382SMartin Schwidefsky #define AP_RESPONSE_INDEX_TOO_BIG 0x11 491534c382SMartin Schwidefsky #define AP_RESPONSE_NO_FIRST_PART 0x13 501534c382SMartin Schwidefsky #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 51a6a5d73aSFelix Beck #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16 521534c382SMartin Schwidefsky 531749a81dSFelix Beck /* 541534c382SMartin Schwidefsky * Known device types 551534c382SMartin Schwidefsky */ 561534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_PCICC 3 571534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_PCICA 4 581534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_PCIXCC 5 591534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_CEX2A 6 601534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_CEX2C 7 61ffda4f71SFelix Beck #define AP_DEVICE_TYPE_CEX3A 8 62ffda4f71SFelix Beck #define AP_DEVICE_TYPE_CEX3C 9 631e2076f4SHolger Dengler #define AP_DEVICE_TYPE_CEX4 10 64bdea1f1bSIngo Tuchscherer #define AP_DEVICE_TYPE_CEX5 11 65b3e8652bSHarald Freudenberger #define AP_DEVICE_TYPE_CEX6 12 661534c382SMartin Schwidefsky 671749a81dSFelix Beck /* 68b26bd941SHolger Dengler * Known function facilities 69b26bd941SHolger Dengler */ 70b26bd941SHolger Dengler #define AP_FUNC_MEX4K 1 71b26bd941SHolger Dengler #define AP_FUNC_CRT4K 2 72b26bd941SHolger Dengler #define AP_FUNC_COPRO 3 73b26bd941SHolger Dengler #define AP_FUNC_ACCEL 4 7491f3e3eaSIngo Tuchscherer #define AP_FUNC_EP11 5 7591f3e3eaSIngo Tuchscherer #define AP_FUNC_APXA 6 76b26bd941SHolger Dengler 77b26bd941SHolger Dengler /* 78c50a160cSIngo Tuchscherer * AP interrupt states 79c50a160cSIngo Tuchscherer */ 80c50a160cSIngo Tuchscherer #define AP_INTR_DISABLED 0 /* AP interrupt disabled */ 81c50a160cSIngo Tuchscherer #define AP_INTR_ENABLED 1 /* AP interrupt enabled */ 823f3007afSMartin Schwidefsky 833f3007afSMartin Schwidefsky /* 843f3007afSMartin Schwidefsky * AP device states 853f3007afSMartin Schwidefsky */ 863f3007afSMartin Schwidefsky enum ap_state { 873f3007afSMartin Schwidefsky AP_STATE_RESET_START, 883f3007afSMartin Schwidefsky AP_STATE_RESET_WAIT, 893f3007afSMartin Schwidefsky AP_STATE_SETIRQ_WAIT, 903f3007afSMartin Schwidefsky AP_STATE_IDLE, 913f3007afSMartin Schwidefsky AP_STATE_WORKING, 923f3007afSMartin Schwidefsky AP_STATE_QUEUE_FULL, 933f3007afSMartin Schwidefsky AP_STATE_SUSPEND_WAIT, 943f3007afSMartin Schwidefsky AP_STATE_BORKED, 953f3007afSMartin Schwidefsky NR_AP_STATES 963f3007afSMartin Schwidefsky }; 973f3007afSMartin Schwidefsky 983f3007afSMartin Schwidefsky /* 993f3007afSMartin Schwidefsky * AP device events 1003f3007afSMartin Schwidefsky */ 1013f3007afSMartin Schwidefsky enum ap_event { 1023f3007afSMartin Schwidefsky AP_EVENT_POLL, 1033f3007afSMartin Schwidefsky AP_EVENT_TIMEOUT, 1043f3007afSMartin Schwidefsky NR_AP_EVENTS 1053f3007afSMartin Schwidefsky }; 1063f3007afSMartin Schwidefsky 1073f3007afSMartin Schwidefsky /* 1083f3007afSMartin Schwidefsky * AP wait behaviour 1093f3007afSMartin Schwidefsky */ 1103f3007afSMartin Schwidefsky enum ap_wait { 1113f3007afSMartin Schwidefsky AP_WAIT_AGAIN, /* retry immediately */ 1123f3007afSMartin Schwidefsky AP_WAIT_TIMEOUT, /* wait for timeout */ 1133f3007afSMartin Schwidefsky AP_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */ 1143f3007afSMartin Schwidefsky AP_WAIT_NONE, /* no wait */ 1153f3007afSMartin Schwidefsky NR_AP_WAIT 1163f3007afSMartin Schwidefsky }; 117af512ed0SRalph Wuerthner 1181534c382SMartin Schwidefsky struct ap_device; 1191534c382SMartin Schwidefsky struct ap_message; 1201534c382SMartin Schwidefsky 1217e0bdbe5SHarald Freudenberger /* 1227e0bdbe5SHarald Freudenberger * The ap driver struct includes a flags field which holds some info for 1237e0bdbe5SHarald Freudenberger * the ap bus about the driver. Currently only one flag is supported and 1247e0bdbe5SHarald Freudenberger * used: The DEFAULT flag marks an ap driver as a default driver which is 1257e0bdbe5SHarald Freudenberger * used together with the apmask and aqmask whitelisting of the ap bus. 1267e0bdbe5SHarald Freudenberger */ 1277e0bdbe5SHarald Freudenberger #define AP_DRIVER_FLAG_DEFAULT 0x0001 1287e0bdbe5SHarald Freudenberger 1291534c382SMartin Schwidefsky struct ap_driver { 1301534c382SMartin Schwidefsky struct device_driver driver; 1311534c382SMartin Schwidefsky struct ap_device_id *ids; 1327e0bdbe5SHarald Freudenberger unsigned int flags; 1331534c382SMartin Schwidefsky 1341534c382SMartin Schwidefsky int (*probe)(struct ap_device *); 1351534c382SMartin Schwidefsky void (*remove)(struct ap_device *); 136e28d2af4SIngo Tuchscherer void (*suspend)(struct ap_device *); 137e28d2af4SIngo Tuchscherer void (*resume)(struct ap_device *); 1381534c382SMartin Schwidefsky }; 1391534c382SMartin Schwidefsky 1401534c382SMartin Schwidefsky #define to_ap_drv(x) container_of((x), struct ap_driver, driver) 1411534c382SMartin Schwidefsky 1421534c382SMartin Schwidefsky int ap_driver_register(struct ap_driver *, struct module *, char *); 1431534c382SMartin Schwidefsky void ap_driver_unregister(struct ap_driver *); 1441534c382SMartin Schwidefsky 1451534c382SMartin Schwidefsky struct ap_device { 1461534c382SMartin Schwidefsky struct device device; 1471534c382SMartin Schwidefsky struct ap_driver *drv; /* Pointer to AP device driver. */ 1481534c382SMartin Schwidefsky int device_type; /* AP device type. */ 1491534c382SMartin Schwidefsky }; 1501534c382SMartin Schwidefsky 1511534c382SMartin Schwidefsky #define to_ap_dev(x) container_of((x), struct ap_device, device) 1521534c382SMartin Schwidefsky 153e28d2af4SIngo Tuchscherer struct ap_card { 154e28d2af4SIngo Tuchscherer struct ap_device ap_dev; 155e28d2af4SIngo Tuchscherer struct list_head list; /* Private list of AP cards. */ 156e28d2af4SIngo Tuchscherer struct list_head queues; /* List of assoc. AP queues */ 157e28d2af4SIngo Tuchscherer void *private; /* ap driver private pointer. */ 158e28d2af4SIngo Tuchscherer int raw_hwtype; /* AP raw hardware type. */ 159e28d2af4SIngo Tuchscherer unsigned int functions; /* AP device function bitfield. */ 160e28d2af4SIngo Tuchscherer int queue_depth; /* AP queue depth.*/ 161e28d2af4SIngo Tuchscherer int id; /* AP card number. */ 162e47de21dSIngo Tuchscherer atomic_t total_request_count; /* # requests ever for this AP device.*/ 163e28d2af4SIngo Tuchscherer }; 164e28d2af4SIngo Tuchscherer 165e28d2af4SIngo Tuchscherer #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device) 166e28d2af4SIngo Tuchscherer 167e28d2af4SIngo Tuchscherer struct ap_queue { 168e28d2af4SIngo Tuchscherer struct ap_device ap_dev; 169e28d2af4SIngo Tuchscherer struct list_head list; /* Private list of AP queues. */ 170e28d2af4SIngo Tuchscherer struct ap_card *card; /* Ptr to assoc. AP card. */ 171e28d2af4SIngo Tuchscherer spinlock_t lock; /* Per device lock. */ 172e28d2af4SIngo Tuchscherer void *private; /* ap driver private pointer. */ 173e28d2af4SIngo Tuchscherer ap_qid_t qid; /* AP queue id. */ 174e28d2af4SIngo Tuchscherer int interrupt; /* indicate if interrupts are enabled */ 175e28d2af4SIngo Tuchscherer int queue_count; /* # messages currently on AP queue. */ 176e28d2af4SIngo Tuchscherer enum ap_state state; /* State of the AP device. */ 177e28d2af4SIngo Tuchscherer int pendingq_count; /* # requests on pendingq list. */ 178e28d2af4SIngo Tuchscherer int requestq_count; /* # requests on requestq list. */ 179e28d2af4SIngo Tuchscherer int total_request_count; /* # requests ever for this AP device.*/ 180ac2b96f3SHarald Freudenberger int request_timeout; /* Request timeout in jiffies. */ 181e28d2af4SIngo Tuchscherer struct timer_list timeout; /* Timer for request timeouts. */ 182e28d2af4SIngo Tuchscherer struct list_head pendingq; /* List of message sent to AP queue. */ 183e28d2af4SIngo Tuchscherer struct list_head requestq; /* List of message yet to be sent. */ 184e28d2af4SIngo Tuchscherer struct ap_message *reply; /* Per device reply message. */ 185e28d2af4SIngo Tuchscherer }; 186e28d2af4SIngo Tuchscherer 187e28d2af4SIngo Tuchscherer #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device) 188e28d2af4SIngo Tuchscherer 189e28d2af4SIngo Tuchscherer typedef enum ap_wait (ap_func_t)(struct ap_queue *queue); 190e28d2af4SIngo Tuchscherer 1911534c382SMartin Schwidefsky struct ap_message { 1921534c382SMartin Schwidefsky struct list_head list; /* Request queueing. */ 1931534c382SMartin Schwidefsky unsigned long long psmid; /* Message id. */ 1941534c382SMartin Schwidefsky void *message; /* Pointer to message buffer. */ 1951534c382SMartin Schwidefsky size_t length; /* Message length. */ 196f58fe336SMartin Schwidefsky int rc; /* Return code for this message */ 1971534c382SMartin Schwidefsky 1981534c382SMartin Schwidefsky void *private; /* ap driver private pointer. */ 199a6a5d73aSFelix Beck unsigned int special:1; /* Used for special commands. */ 20054a8f561SHolger Dengler /* receive is called from tasklet context */ 201e28d2af4SIngo Tuchscherer void (*receive)(struct ap_queue *, struct ap_message *, 20254a8f561SHolger Dengler struct ap_message *); 2031534c382SMartin Schwidefsky }; 2041534c382SMartin Schwidefsky 205468ffddfSFelix Beck /** 206468ffddfSFelix Beck * ap_init_message() - Initialize ap_message. 207468ffddfSFelix Beck * Initialize a message before using. Otherwise this might result in 208468ffddfSFelix Beck * unexpected behaviour. 209468ffddfSFelix Beck */ 210468ffddfSFelix Beck static inline void ap_init_message(struct ap_message *ap_msg) 211468ffddfSFelix Beck { 21289a0c0ecSHarald Freudenberger memset(ap_msg, 0, sizeof(*ap_msg)); 21389a0c0ecSHarald Freudenberger } 21489a0c0ecSHarald Freudenberger 21589a0c0ecSHarald Freudenberger /** 21689a0c0ecSHarald Freudenberger * ap_release_message() - Release ap_message. 21789a0c0ecSHarald Freudenberger * Releases all memory used internal within the ap_message struct 21889a0c0ecSHarald Freudenberger * Currently this is the message and private field. 21989a0c0ecSHarald Freudenberger */ 22089a0c0ecSHarald Freudenberger static inline void ap_release_message(struct ap_message *ap_msg) 22189a0c0ecSHarald Freudenberger { 22289a0c0ecSHarald Freudenberger kzfree(ap_msg->message); 22389a0c0ecSHarald Freudenberger kzfree(ap_msg->private); 224468ffddfSFelix Beck } 225468ffddfSFelix Beck 226e28d2af4SIngo Tuchscherer #define for_each_ap_card(_ac) \ 227e28d2af4SIngo Tuchscherer list_for_each_entry(_ac, &ap_card_list, list) 228e28d2af4SIngo Tuchscherer 229e28d2af4SIngo Tuchscherer #define for_each_ap_queue(_aq, _ac) \ 230e28d2af4SIngo Tuchscherer list_for_each_entry(_aq, &(_ac)->queues, list) 231e28d2af4SIngo Tuchscherer 2321749a81dSFelix Beck /* 2331534c382SMartin Schwidefsky * Note: don't use ap_send/ap_recv after using ap_queue_message 2341534c382SMartin Schwidefsky * for the first time. Otherwise the ap message queue will get 2351534c382SMartin Schwidefsky * confused. 2361534c382SMartin Schwidefsky */ 2371534c382SMartin Schwidefsky int ap_send(ap_qid_t, unsigned long long, void *, size_t); 2381534c382SMartin Schwidefsky int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 2391534c382SMartin Schwidefsky 240e28d2af4SIngo Tuchscherer enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event); 241e28d2af4SIngo Tuchscherer enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event); 242e28d2af4SIngo Tuchscherer 243e28d2af4SIngo Tuchscherer void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg); 244e28d2af4SIngo Tuchscherer void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg); 245e28d2af4SIngo Tuchscherer void ap_flush_queue(struct ap_queue *aq); 246e28d2af4SIngo Tuchscherer 247e28d2af4SIngo Tuchscherer void *ap_airq_ptr(void); 248e28d2af4SIngo Tuchscherer void ap_wait(enum ap_wait wait); 249cefbeb5dSKees Cook void ap_request_timeout(struct timer_list *t); 250dabecb29SHolger Dengler void ap_bus_force_rescan(void); 251e28d2af4SIngo Tuchscherer 252e28d2af4SIngo Tuchscherer void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg); 253e28d2af4SIngo Tuchscherer struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type); 254e28d2af4SIngo Tuchscherer void ap_queue_remove(struct ap_queue *aq); 255e28d2af4SIngo Tuchscherer void ap_queue_suspend(struct ap_device *ap_dev); 256e28d2af4SIngo Tuchscherer void ap_queue_resume(struct ap_device *ap_dev); 257104f708fSHarald Freudenberger void ap_queue_reinit_state(struct ap_queue *aq); 258e28d2af4SIngo Tuchscherer 2599a564108SHarald Freudenberger struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type, 2609a564108SHarald Freudenberger int comp_device_type, unsigned int functions); 2611534c382SMartin Schwidefsky 26200fab235SHarald Freudenberger struct ap_perms { 26300fab235SHarald Freudenberger unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)]; 26400fab235SHarald Freudenberger unsigned long apm[BITS_TO_LONGS(AP_DEVICES)]; 26500fab235SHarald Freudenberger unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)]; 26600fab235SHarald Freudenberger }; 26700fab235SHarald Freudenberger extern struct ap_perms ap_perms; 26800fab235SHarald Freudenberger extern struct mutex ap_perms_mutex; 26900fab235SHarald Freudenberger 2707e0bdbe5SHarald Freudenberger /* 2717e0bdbe5SHarald Freudenberger * check APQN for owned/reserved by ap bus and default driver(s). 2727e0bdbe5SHarald Freudenberger * Checks if this APQN is or will be in use by the ap bus 2737e0bdbe5SHarald Freudenberger * and the default set of drivers. 2747e0bdbe5SHarald Freudenberger * If yes, returns 1, if not returns 0. On error a negative 2757e0bdbe5SHarald Freudenberger * errno value is returned. 2767e0bdbe5SHarald Freudenberger */ 2777e0bdbe5SHarald Freudenberger int ap_owned_by_def_drv(int card, int queue); 2787e0bdbe5SHarald Freudenberger 2797e0bdbe5SHarald Freudenberger /* 2807e0bdbe5SHarald Freudenberger * check 'matrix' of APQNs for owned/reserved by ap bus and 2817e0bdbe5SHarald Freudenberger * default driver(s). 2827e0bdbe5SHarald Freudenberger * Checks if there is at least one APQN in the given 'matrix' 2837e0bdbe5SHarald Freudenberger * marked as owned/reserved by the ap bus and default driver(s). 2847e0bdbe5SHarald Freudenberger * If such an APQN is found the return value is 1, otherwise 2857e0bdbe5SHarald Freudenberger * 0 is returned. On error a negative errno value is returned. 2867e0bdbe5SHarald Freudenberger * The parameter apm is a bitmask which should be declared 2877e0bdbe5SHarald Freudenberger * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is 2887e0bdbe5SHarald Freudenberger * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS). 2897e0bdbe5SHarald Freudenberger */ 2907e0bdbe5SHarald Freudenberger int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm, 2917e0bdbe5SHarald Freudenberger unsigned long *aqm); 2927e0bdbe5SHarald Freudenberger 29300fab235SHarald Freudenberger /* 29400fab235SHarald Freudenberger * ap_parse_mask_str() - helper function to parse a bitmap string 29500fab235SHarald Freudenberger * and clear/set the bits in the bitmap accordingly. The string may be 29600fab235SHarald Freudenberger * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple 29700fab235SHarald Freudenberger * overwriting the current content of the bitmap. Or as relative string 29800fab235SHarald Freudenberger * like "+1-16,-32,-0x40,+128" where only single bits or ranges of 29900fab235SHarald Freudenberger * bits are cleared or set. Distinction is done based on the very 30000fab235SHarald Freudenberger * first character which may be '+' or '-' for the relative string 30100fab235SHarald Freudenberger * and othewise assume to be an absolute value string. If parsing fails 30200fab235SHarald Freudenberger * a negative errno value is returned. All arguments and bitmaps are 30300fab235SHarald Freudenberger * big endian order. 30400fab235SHarald Freudenberger */ 30500fab235SHarald Freudenberger int ap_parse_mask_str(const char *str, 30600fab235SHarald Freudenberger unsigned long *bitmap, int bits, 30700fab235SHarald Freudenberger struct mutex *lock); 30800fab235SHarald Freudenberger 3091534c382SMartin Schwidefsky #endif /* _AP_BUS_H_ */ 310