1ac2b96f3SHarald Freudenberger /* SPDX-License-Identifier: GPL-2.0+ */ 21534c382SMartin Schwidefsky /* 3cf2957f3SHarald Freudenberger * Copyright IBM Corp. 2006, 2019 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> 18bc4b295eSHarald Freudenberger #include <linux/hashtable.h> 19f1b0a434SHarald Freudenberger #include <asm/isc.h> 20e7fc5146STony Krowiak #include <asm/ap.h> 211534c382SMartin Schwidefsky 22af4a7227SHarald Freudenberger #define AP_DEVICES 256 /* Number of AP devices. */ 23170387a8SIngo Tuchscherer #define AP_DOMAINS 256 /* Number of AP domains. */ 2400fab235SHarald Freudenberger #define AP_IOCTLS 256 /* Number of ioctls. */ 2591f3e3eaSIngo Tuchscherer #define AP_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */ 261534c382SMartin Schwidefsky #define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */ 271534c382SMartin Schwidefsky #define AP_POLL_TIME 1 /* Time in ticks between receive polls. */ 28bd39654aSHarald Freudenberger #define AP_DEFAULT_MAX_MSG_SIZE (12 * 1024) 29bd39654aSHarald Freudenberger #define AP_TAPQ_ML_FIELD_CHUNK_SIZE (4096) 301534c382SMartin Schwidefsky 311534c382SMartin Schwidefsky extern int ap_domain_index; 32bd39654aSHarald Freudenberger extern atomic_t ap_max_msg_size; 331534c382SMartin Schwidefsky 34bc4b295eSHarald Freudenberger extern DECLARE_HASHTABLE(ap_queues, 8); 35bc4b295eSHarald Freudenberger extern spinlock_t ap_queues_lock; 36e28d2af4SIngo Tuchscherer 3775014550SHolger Dengler static inline int ap_test_bit(unsigned int *ptr, unsigned int nr) 386bed05bcSHolger Dengler { 3975014550SHolger Dengler return (*ptr & (0x80000000u >> nr)) != 0; 406bed05bcSHolger Dengler } 411534c382SMartin Schwidefsky 421534c382SMartin Schwidefsky #define AP_RESPONSE_NORMAL 0x00 431534c382SMartin Schwidefsky #define AP_RESPONSE_Q_NOT_AVAIL 0x01 441534c382SMartin Schwidefsky #define AP_RESPONSE_RESET_IN_PROGRESS 0x02 451534c382SMartin Schwidefsky #define AP_RESPONSE_DECONFIGURED 0x03 461534c382SMartin Schwidefsky #define AP_RESPONSE_CHECKSTOPPED 0x04 471534c382SMartin Schwidefsky #define AP_RESPONSE_BUSY 0x05 48cb17a636SFelix Beck #define AP_RESPONSE_INVALID_ADDRESS 0x06 49cb17a636SFelix Beck #define AP_RESPONSE_OTHERWISE_CHANGED 0x07 50783f0a3cSTony Krowiak #define AP_RESPONSE_INVALID_GISA 0x08 511534c382SMartin Schwidefsky #define AP_RESPONSE_Q_FULL 0x10 521534c382SMartin Schwidefsky #define AP_RESPONSE_NO_PENDING_REPLY 0x10 531534c382SMartin Schwidefsky #define AP_RESPONSE_INDEX_TOO_BIG 0x11 541534c382SMartin Schwidefsky #define AP_RESPONSE_NO_FIRST_PART 0x13 551534c382SMartin Schwidefsky #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 56a6a5d73aSFelix Beck #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16 57e0332629SHarald Freudenberger #define AP_RESPONSE_INVALID_DOMAIN 0x42 581534c382SMartin Schwidefsky 591749a81dSFelix Beck /* 601534c382SMartin Schwidefsky * Known device types 611534c382SMartin Schwidefsky */ 621534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_PCICC 3 631534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_PCICA 4 641534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_PCIXCC 5 651534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_CEX2A 6 661534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_CEX2C 7 67ffda4f71SFelix Beck #define AP_DEVICE_TYPE_CEX3A 8 68ffda4f71SFelix Beck #define AP_DEVICE_TYPE_CEX3C 9 691e2076f4SHolger Dengler #define AP_DEVICE_TYPE_CEX4 10 70bdea1f1bSIngo Tuchscherer #define AP_DEVICE_TYPE_CEX5 11 71b3e8652bSHarald Freudenberger #define AP_DEVICE_TYPE_CEX6 12 72cf2957f3SHarald Freudenberger #define AP_DEVICE_TYPE_CEX7 13 73985214afSHarald Freudenberger #define AP_DEVICE_TYPE_CEX8 14 741534c382SMartin Schwidefsky 751749a81dSFelix Beck /* 76b26bd941SHolger Dengler * Known function facilities 77b26bd941SHolger Dengler */ 78b26bd941SHolger Dengler #define AP_FUNC_MEX4K 1 79b26bd941SHolger Dengler #define AP_FUNC_CRT4K 2 80b26bd941SHolger Dengler #define AP_FUNC_COPRO 3 81b26bd941SHolger Dengler #define AP_FUNC_ACCEL 4 8291f3e3eaSIngo Tuchscherer #define AP_FUNC_EP11 5 8391f3e3eaSIngo Tuchscherer #define AP_FUNC_APXA 6 84b26bd941SHolger Dengler 85b26bd941SHolger Dengler /* 86dc4b6dedSHarald Freudenberger * AP queue state machine states 873f3007afSMartin Schwidefsky */ 88dc4b6dedSHarald Freudenberger enum ap_sm_state { 890b641cbdSHarald Freudenberger AP_SM_STATE_RESET_START = 0, 90dc4b6dedSHarald Freudenberger AP_SM_STATE_RESET_WAIT, 91dc4b6dedSHarald Freudenberger AP_SM_STATE_SETIRQ_WAIT, 92dc4b6dedSHarald Freudenberger AP_SM_STATE_IDLE, 93dc4b6dedSHarald Freudenberger AP_SM_STATE_WORKING, 94dc4b6dedSHarald Freudenberger AP_SM_STATE_QUEUE_FULL, 95dc4b6dedSHarald Freudenberger NR_AP_SM_STATES 963f3007afSMartin Schwidefsky }; 973f3007afSMartin Schwidefsky 983f3007afSMartin Schwidefsky /* 99dc4b6dedSHarald Freudenberger * AP queue state machine events 1003f3007afSMartin Schwidefsky */ 101dc4b6dedSHarald Freudenberger enum ap_sm_event { 102dc4b6dedSHarald Freudenberger AP_SM_EVENT_POLL, 103dc4b6dedSHarald Freudenberger AP_SM_EVENT_TIMEOUT, 104dc4b6dedSHarald Freudenberger NR_AP_SM_EVENTS 1053f3007afSMartin Schwidefsky }; 1063f3007afSMartin Schwidefsky 1073f3007afSMartin Schwidefsky /* 108dc4b6dedSHarald Freudenberger * AP queue state wait behaviour 1093f3007afSMartin Schwidefsky */ 110dc4b6dedSHarald Freudenberger enum ap_sm_wait { 111cabebb69SHarald Freudenberger AP_SM_WAIT_AGAIN = 0, /* retry immediately */ 112dc4b6dedSHarald Freudenberger AP_SM_WAIT_TIMEOUT, /* wait for timeout */ 113dc4b6dedSHarald Freudenberger AP_SM_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */ 114dc4b6dedSHarald Freudenberger AP_SM_WAIT_NONE, /* no wait */ 115dc4b6dedSHarald Freudenberger NR_AP_SM_WAIT 1163f3007afSMartin Schwidefsky }; 117af512ed0SRalph Wuerthner 1180b641cbdSHarald Freudenberger /* 1190b641cbdSHarald Freudenberger * AP queue device states 1200b641cbdSHarald Freudenberger */ 1210b641cbdSHarald Freudenberger enum ap_dev_state { 1220b641cbdSHarald Freudenberger AP_DEV_STATE_UNINITIATED = 0, /* fresh and virgin, not touched */ 1230b641cbdSHarald Freudenberger AP_DEV_STATE_OPERATING, /* queue dev is working normal */ 1240b641cbdSHarald Freudenberger AP_DEV_STATE_SHUTDOWN, /* remove/unbind/shutdown in progress */ 1250b641cbdSHarald Freudenberger AP_DEV_STATE_ERROR, /* device is in error state */ 1260b641cbdSHarald Freudenberger NR_AP_DEV_STATES 1270b641cbdSHarald Freudenberger }; 1280b641cbdSHarald Freudenberger 1291534c382SMartin Schwidefsky struct ap_device; 1301534c382SMartin Schwidefsky struct ap_message; 1311534c382SMartin Schwidefsky 1327e0bdbe5SHarald Freudenberger /* 1337e0bdbe5SHarald Freudenberger * The ap driver struct includes a flags field which holds some info for 1347e0bdbe5SHarald Freudenberger * the ap bus about the driver. Currently only one flag is supported and 1357e0bdbe5SHarald Freudenberger * used: The DEFAULT flag marks an ap driver as a default driver which is 1367e0bdbe5SHarald Freudenberger * used together with the apmask and aqmask whitelisting of the ap bus. 1377e0bdbe5SHarald Freudenberger */ 1387e0bdbe5SHarald Freudenberger #define AP_DRIVER_FLAG_DEFAULT 0x0001 1397e0bdbe5SHarald Freudenberger 1401534c382SMartin Schwidefsky struct ap_driver { 1411534c382SMartin Schwidefsky struct device_driver driver; 1421534c382SMartin Schwidefsky struct ap_device_id *ids; 1437e0bdbe5SHarald Freudenberger unsigned int flags; 1441534c382SMartin Schwidefsky 1451534c382SMartin Schwidefsky int (*probe)(struct ap_device *); 1461534c382SMartin Schwidefsky void (*remove)(struct ap_device *); 1474f8206b8STony Krowiak int (*in_use)(unsigned long *apm, unsigned long *aqm); 14828391585STony Krowiak /* 14928391585STony Krowiak * Called at the start of the ap bus scan function when 15028391585STony Krowiak * the crypto config information (qci) has changed. 151*0fef40beSHarald Freudenberger * This callback is not invoked if there is no AP 152*0fef40beSHarald Freudenberger * QCI support available. 15328391585STony Krowiak */ 15428391585STony Krowiak void (*on_config_changed)(struct ap_config_info *new_config_info, 15528391585STony Krowiak struct ap_config_info *old_config_info); 15628391585STony Krowiak /* 15728391585STony Krowiak * Called at the end of the ap bus scan function when 15828391585STony Krowiak * the crypto config information (qci) has changed. 159*0fef40beSHarald Freudenberger * This callback is not invoked if there is no AP 160*0fef40beSHarald Freudenberger * QCI support available. 16128391585STony Krowiak */ 16228391585STony Krowiak void (*on_scan_complete)(struct ap_config_info *new_config_info, 16328391585STony Krowiak struct ap_config_info *old_config_info); 1641534c382SMartin Schwidefsky }; 1651534c382SMartin Schwidefsky 1661534c382SMartin Schwidefsky #define to_ap_drv(x) container_of((x), struct ap_driver, driver) 1671534c382SMartin Schwidefsky 1681534c382SMartin Schwidefsky int ap_driver_register(struct ap_driver *, struct module *, char *); 1691534c382SMartin Schwidefsky void ap_driver_unregister(struct ap_driver *); 1701534c382SMartin Schwidefsky 1711534c382SMartin Schwidefsky struct ap_device { 1721534c382SMartin Schwidefsky struct device device; 1731534c382SMartin Schwidefsky int device_type; /* AP device type. */ 1741534c382SMartin Schwidefsky }; 1751534c382SMartin Schwidefsky 1761534c382SMartin Schwidefsky #define to_ap_dev(x) container_of((x), struct ap_device, device) 1771534c382SMartin Schwidefsky 178e28d2af4SIngo Tuchscherer struct ap_card { 179e28d2af4SIngo Tuchscherer struct ap_device ap_dev; 180e28d2af4SIngo Tuchscherer int raw_hwtype; /* AP raw hardware type. */ 181e28d2af4SIngo Tuchscherer unsigned int functions; /* AP device function bitfield. */ 182e28d2af4SIngo Tuchscherer int queue_depth; /* AP queue depth.*/ 183e28d2af4SIngo Tuchscherer int id; /* AP card number. */ 184bd39654aSHarald Freudenberger unsigned int maxmsgsize; /* AP msg limit for this card */ 1854f2fcccdSHarald Freudenberger bool config; /* configured state */ 186a7e701dbSHarald Freudenberger bool chkstop; /* checkstop state */ 187fcd98d40SHarald Freudenberger atomic64_t total_request_count; /* # requests ever for this AP device.*/ 188e28d2af4SIngo Tuchscherer }; 189e28d2af4SIngo Tuchscherer 190e28d2af4SIngo Tuchscherer #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device) 191e28d2af4SIngo Tuchscherer 192e28d2af4SIngo Tuchscherer struct ap_queue { 193e28d2af4SIngo Tuchscherer struct ap_device ap_dev; 194bc4b295eSHarald Freudenberger struct hlist_node hnode; /* Node for the ap_queues hashtable */ 195e28d2af4SIngo Tuchscherer struct ap_card *card; /* Ptr to assoc. AP card. */ 196e28d2af4SIngo Tuchscherer spinlock_t lock; /* Per device lock. */ 1970b641cbdSHarald Freudenberger enum ap_dev_state dev_state; /* queue device state */ 1984f2fcccdSHarald Freudenberger bool config; /* configured state */ 199a7e701dbSHarald Freudenberger bool chkstop; /* checkstop state */ 200e28d2af4SIngo Tuchscherer ap_qid_t qid; /* AP queue id. */ 201cabebb69SHarald Freudenberger bool interrupt; /* indicate if interrupts are enabled */ 202e28d2af4SIngo Tuchscherer int queue_count; /* # messages currently on AP queue. */ 203e28d2af4SIngo Tuchscherer int pendingq_count; /* # requests on pendingq list. */ 204e28d2af4SIngo Tuchscherer int requestq_count; /* # requests on requestq list. */ 205fcd98d40SHarald Freudenberger u64 total_request_count; /* # requests ever for this AP device.*/ 206ac2b96f3SHarald Freudenberger int request_timeout; /* Request timeout in jiffies. */ 207e28d2af4SIngo Tuchscherer struct timer_list timeout; /* Timer for request timeouts. */ 208e28d2af4SIngo Tuchscherer struct list_head pendingq; /* List of message sent to AP queue. */ 209e28d2af4SIngo Tuchscherer struct list_head requestq; /* List of message yet to be sent. */ 210e28d2af4SIngo Tuchscherer struct ap_message *reply; /* Per device reply message. */ 2110b641cbdSHarald Freudenberger enum ap_sm_state sm_state; /* ap queue state machine state */ 2122ea2a609SHarald Freudenberger int last_err_rc; /* last error state response code */ 213e28d2af4SIngo Tuchscherer }; 214e28d2af4SIngo Tuchscherer 215e28d2af4SIngo Tuchscherer #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device) 216e28d2af4SIngo Tuchscherer 217dc4b6dedSHarald Freudenberger typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue); 218e28d2af4SIngo Tuchscherer 21927c4f673SHarald Freudenberger /* failure injection cmd struct */ 22027c4f673SHarald Freudenberger struct ap_fi { 22127c4f673SHarald Freudenberger union { 22227c4f673SHarald Freudenberger u16 cmd; /* fi flags + action */ 22327c4f673SHarald Freudenberger struct { 22427c4f673SHarald Freudenberger u8 flags; /* fi flags only */ 22527c4f673SHarald Freudenberger u8 action; /* fi action only */ 22627c4f673SHarald Freudenberger }; 22727c4f673SHarald Freudenberger }; 22827c4f673SHarald Freudenberger }; 22927c4f673SHarald Freudenberger 23027c4f673SHarald Freudenberger /* all currently known fi actions */ 23127c4f673SHarald Freudenberger enum ap_fi_actions { 23227c4f673SHarald Freudenberger AP_FI_ACTION_CCA_AGENT_FF = 0x01, 23327c4f673SHarald Freudenberger AP_FI_ACTION_CCA_DOM_INVAL = 0x02, 23427c4f673SHarald Freudenberger AP_FI_ACTION_NQAP_QID_INVAL = 0x03, 23527c4f673SHarald Freudenberger }; 23627c4f673SHarald Freudenberger 23727c4f673SHarald Freudenberger /* all currently known fi flags */ 23827c4f673SHarald Freudenberger enum ap_fi_flags { 23927c4f673SHarald Freudenberger AP_FI_FLAG_NO_RETRY = 0x01, 24027c4f673SHarald Freudenberger AP_FI_FLAG_TOGGLE_SPECIAL = 0x02, 24127c4f673SHarald Freudenberger }; 24227c4f673SHarald Freudenberger 2431534c382SMartin Schwidefsky struct ap_message { 2441534c382SMartin Schwidefsky struct list_head list; /* Request queueing. */ 2451534c382SMartin Schwidefsky unsigned long long psmid; /* Message id. */ 24674ecbef7SHarald Freudenberger void *msg; /* Pointer to message buffer. */ 247bd39654aSHarald Freudenberger unsigned int len; /* actual msg len in msg buffer */ 248bd39654aSHarald Freudenberger unsigned int bufsize; /* allocated msg buffer size */ 24927c4f673SHarald Freudenberger u16 flags; /* Flags, see AP_MSG_FLAG_xxx */ 25027c4f673SHarald Freudenberger struct ap_fi fi; /* Failure Injection cmd */ 251f58fe336SMartin Schwidefsky int rc; /* Return code for this message */ 2521534c382SMartin Schwidefsky void *private; /* ap driver private pointer. */ 25354a8f561SHolger Dengler /* receive is called from tasklet context */ 254e28d2af4SIngo Tuchscherer void (*receive)(struct ap_queue *, struct ap_message *, 25554a8f561SHolger Dengler struct ap_message *); 2561534c382SMartin Schwidefsky }; 2571534c382SMartin Schwidefsky 258383366b5SHarald Freudenberger #define AP_MSG_FLAG_SPECIAL 0x0001 /* flag msg as 'special' with NQAP */ 259383366b5SHarald Freudenberger #define AP_MSG_FLAG_USAGE 0x0002 /* CCA, EP11: usage (no admin) msg */ 260383366b5SHarald Freudenberger #define AP_MSG_FLAG_ADMIN 0x0004 /* CCA, EP11: admin (=control) msg */ 26174ecbef7SHarald Freudenberger 262468ffddfSFelix Beck /** 263468ffddfSFelix Beck * ap_init_message() - Initialize ap_message. 264468ffddfSFelix Beck * Initialize a message before using. Otherwise this might result in 265468ffddfSFelix Beck * unexpected behaviour. 266468ffddfSFelix Beck */ 267468ffddfSFelix Beck static inline void ap_init_message(struct ap_message *ap_msg) 268468ffddfSFelix Beck { 26989a0c0ecSHarald Freudenberger memset(ap_msg, 0, sizeof(*ap_msg)); 27089a0c0ecSHarald Freudenberger } 27189a0c0ecSHarald Freudenberger 27289a0c0ecSHarald Freudenberger /** 27389a0c0ecSHarald Freudenberger * ap_release_message() - Release ap_message. 27489a0c0ecSHarald Freudenberger * Releases all memory used internal within the ap_message struct 27589a0c0ecSHarald Freudenberger * Currently this is the message and private field. 27689a0c0ecSHarald Freudenberger */ 27789a0c0ecSHarald Freudenberger static inline void ap_release_message(struct ap_message *ap_msg) 27889a0c0ecSHarald Freudenberger { 279453431a5SWaiman Long kfree_sensitive(ap_msg->msg); 280453431a5SWaiman Long kfree_sensitive(ap_msg->private); 281468ffddfSFelix Beck } 282468ffddfSFelix Beck 2831749a81dSFelix Beck /* 2841534c382SMartin Schwidefsky * Note: don't use ap_send/ap_recv after using ap_queue_message 2851534c382SMartin Schwidefsky * for the first time. Otherwise the ap message queue will get 2861534c382SMartin Schwidefsky * confused. 2871534c382SMartin Schwidefsky */ 2881534c382SMartin Schwidefsky int ap_send(ap_qid_t, unsigned long long, void *, size_t); 2891534c382SMartin Schwidefsky int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 2901534c382SMartin Schwidefsky 291dc4b6dedSHarald Freudenberger enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event); 292dc4b6dedSHarald Freudenberger enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event); 293e28d2af4SIngo Tuchscherer 2940b641cbdSHarald Freudenberger int ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg); 295e28d2af4SIngo Tuchscherer void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg); 296e28d2af4SIngo Tuchscherer void ap_flush_queue(struct ap_queue *aq); 297e28d2af4SIngo Tuchscherer 298e28d2af4SIngo Tuchscherer void *ap_airq_ptr(void); 299dc4b6dedSHarald Freudenberger void ap_wait(enum ap_sm_wait wait); 300cefbeb5dSKees Cook void ap_request_timeout(struct timer_list *t); 301dabecb29SHolger Dengler void ap_bus_force_rescan(void); 302e28d2af4SIngo Tuchscherer 3037379e652SHarald Freudenberger int ap_test_config_usage_domain(unsigned int domain); 3047379e652SHarald Freudenberger int ap_test_config_ctrl_domain(unsigned int domain); 3057379e652SHarald Freudenberger 306e28d2af4SIngo Tuchscherer void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg); 307e28d2af4SIngo Tuchscherer struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type); 30801396a37SHarald Freudenberger void ap_queue_prepare_remove(struct ap_queue *aq); 309e28d2af4SIngo Tuchscherer void ap_queue_remove(struct ap_queue *aq); 3100c874cd0SHarald Freudenberger void ap_queue_init_state(struct ap_queue *aq); 311e28d2af4SIngo Tuchscherer 312bd39654aSHarald Freudenberger struct ap_card *ap_card_create(int id, int queue_depth, int raw_type, 313bd39654aSHarald Freudenberger int comp_type, unsigned int functions, int ml); 3141534c382SMartin Schwidefsky 3154f8206b8STony Krowiak #define APMASKSIZE (BITS_TO_LONGS(AP_DEVICES) * sizeof(unsigned long)) 3164f8206b8STony Krowiak #define AQMASKSIZE (BITS_TO_LONGS(AP_DOMAINS) * sizeof(unsigned long)) 3174f8206b8STony Krowiak 31800fab235SHarald Freudenberger struct ap_perms { 31900fab235SHarald Freudenberger unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)]; 32000fab235SHarald Freudenberger unsigned long apm[BITS_TO_LONGS(AP_DEVICES)]; 32100fab235SHarald Freudenberger unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)]; 322895ae58dSJuergen Christ unsigned long adm[BITS_TO_LONGS(AP_DOMAINS)]; 32300fab235SHarald Freudenberger }; 3242004b57cSHarald Freudenberger 32500fab235SHarald Freudenberger extern struct ap_perms ap_perms; 32600fab235SHarald Freudenberger extern struct mutex ap_perms_mutex; 32700fab235SHarald Freudenberger 3287e0bdbe5SHarald Freudenberger /* 329bc4b295eSHarald Freudenberger * Get ap_queue device for this qid. 330bc4b295eSHarald Freudenberger * Returns ptr to the struct ap_queue device or NULL if there 331bc4b295eSHarald Freudenberger * was no ap_queue device with this qid found. When something is 332bc4b295eSHarald Freudenberger * found, the reference count of the embedded device is increased. 333bc4b295eSHarald Freudenberger * So the caller has to decrease the reference count after use 334bc4b295eSHarald Freudenberger * with a call to put_device(&aq->ap_dev.device). 335bc4b295eSHarald Freudenberger */ 336bc4b295eSHarald Freudenberger struct ap_queue *ap_get_qdev(ap_qid_t qid); 337bc4b295eSHarald Freudenberger 338bc4b295eSHarald Freudenberger /* 3397e0bdbe5SHarald Freudenberger * check APQN for owned/reserved by ap bus and default driver(s). 3407e0bdbe5SHarald Freudenberger * Checks if this APQN is or will be in use by the ap bus 3417e0bdbe5SHarald Freudenberger * and the default set of drivers. 3427e0bdbe5SHarald Freudenberger * If yes, returns 1, if not returns 0. On error a negative 3437e0bdbe5SHarald Freudenberger * errno value is returned. 3447e0bdbe5SHarald Freudenberger */ 3457e0bdbe5SHarald Freudenberger int ap_owned_by_def_drv(int card, int queue); 3467e0bdbe5SHarald Freudenberger 3477e0bdbe5SHarald Freudenberger /* 3487e0bdbe5SHarald Freudenberger * check 'matrix' of APQNs for owned/reserved by ap bus and 3497e0bdbe5SHarald Freudenberger * default driver(s). 3507e0bdbe5SHarald Freudenberger * Checks if there is at least one APQN in the given 'matrix' 3517e0bdbe5SHarald Freudenberger * marked as owned/reserved by the ap bus and default driver(s). 3527e0bdbe5SHarald Freudenberger * If such an APQN is found the return value is 1, otherwise 3537e0bdbe5SHarald Freudenberger * 0 is returned. On error a negative errno value is returned. 3547e0bdbe5SHarald Freudenberger * The parameter apm is a bitmask which should be declared 3557e0bdbe5SHarald Freudenberger * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is 3567e0bdbe5SHarald Freudenberger * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS). 3577e0bdbe5SHarald Freudenberger */ 3587e0bdbe5SHarald Freudenberger int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm, 3597e0bdbe5SHarald Freudenberger unsigned long *aqm); 3607e0bdbe5SHarald Freudenberger 36100fab235SHarald Freudenberger /* 36200fab235SHarald Freudenberger * ap_parse_mask_str() - helper function to parse a bitmap string 36300fab235SHarald Freudenberger * and clear/set the bits in the bitmap accordingly. The string may be 36400fab235SHarald Freudenberger * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple 36500fab235SHarald Freudenberger * overwriting the current content of the bitmap. Or as relative string 36600fab235SHarald Freudenberger * like "+1-16,-32,-0x40,+128" where only single bits or ranges of 36700fab235SHarald Freudenberger * bits are cleared or set. Distinction is done based on the very 36800fab235SHarald Freudenberger * first character which may be '+' or '-' for the relative string 36900fab235SHarald Freudenberger * and othewise assume to be an absolute value string. If parsing fails 37000fab235SHarald Freudenberger * a negative errno value is returned. All arguments and bitmaps are 37100fab235SHarald Freudenberger * big endian order. 37200fab235SHarald Freudenberger */ 37300fab235SHarald Freudenberger int ap_parse_mask_str(const char *str, 37400fab235SHarald Freudenberger unsigned long *bitmap, int bits, 37500fab235SHarald Freudenberger struct mutex *lock); 37600fab235SHarald Freudenberger 377837cd105SHarald Freudenberger /* 378837cd105SHarald Freudenberger * Interface to wait for the AP bus to have done one initial ap bus 379837cd105SHarald Freudenberger * scan and all detected APQNs have been bound to device drivers. 380837cd105SHarald Freudenberger * If these both conditions are not fulfilled, this function blocks 381837cd105SHarald Freudenberger * on a condition with wait_for_completion_killable_timeout(). 382837cd105SHarald Freudenberger * If these both conditions are fulfilled (before the timeout hits) 383837cd105SHarald Freudenberger * the return value is 0. If the timeout (in jiffies) hits instead 384837cd105SHarald Freudenberger * -ETIME is returned. On failures negative return values are 385837cd105SHarald Freudenberger * returned to the caller. 386837cd105SHarald Freudenberger */ 387837cd105SHarald Freudenberger int ap_wait_init_apqn_bindings_complete(unsigned long timeout); 388837cd105SHarald Freudenberger 389df6f508cSHarald Freudenberger void ap_send_config_uevent(struct ap_device *ap_dev, bool cfg); 390df6f508cSHarald Freudenberger void ap_send_online_uevent(struct ap_device *ap_dev, int online); 391df6f508cSHarald Freudenberger 3921534c382SMartin Schwidefsky #endif /* _AP_BUS_H_ */ 393