Harald Freudenberger | ac2b96f | 2018-08-17 12:36:01 +0200 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 2 | /* |
Harald Freudenberger | cf2957f | 2019-08-16 11:05:58 +0200 | [diff] [blame] | 3 | * Copyright IBM Corp. 2006, 2019 |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 4 | * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com> |
| 5 | * Martin Schwidefsky <schwidefsky@de.ibm.com> |
| 6 | * Ralph Wuerthner <rwuerthn@de.ibm.com> |
Felix Beck | cb17a63 | 2008-12-25 13:38:41 +0100 | [diff] [blame] | 7 | * Felix Beck <felix.beck@de.ibm.com> |
Holger Dengler | 6bed05b | 2011-07-24 10:48:25 +0200 | [diff] [blame] | 8 | * Holger Dengler <hd@linux.vnet.ibm.com> |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 9 | * |
| 10 | * Adjunct processor bus header file. |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 11 | */ |
| 12 | |
| 13 | #ifndef _AP_BUS_H_ |
| 14 | #define _AP_BUS_H_ |
| 15 | |
| 16 | #include <linux/device.h> |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 17 | #include <linux/types.h> |
Harald Freudenberger | bc4b295 | 2020-05-08 15:51:19 +0200 | [diff] [blame] | 18 | #include <linux/hashtable.h> |
Harald Freudenberger | f1b0a434 | 2018-06-12 15:42:36 +0200 | [diff] [blame] | 19 | #include <asm/isc.h> |
Tony Krowiak | e7fc514 | 2016-11-08 07:09:13 +0100 | [diff] [blame] | 20 | #include <asm/ap.h> |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 21 | |
Harald Freudenberger | af4a722 | 2018-04-09 16:18:37 +0200 | [diff] [blame] | 22 | #define AP_DEVICES 256 /* Number of AP devices. */ |
Ingo Tuchscherer | 170387a | 2014-09-08 13:24:13 +0200 | [diff] [blame] | 23 | #define AP_DOMAINS 256 /* Number of AP domains. */ |
Harald Freudenberger | 00fab23 | 2018-09-17 16:18:41 +0200 | [diff] [blame] | 24 | #define AP_IOCTLS 256 /* Number of ioctls. */ |
Ingo Tuchscherer | 91f3e3ea | 2013-11-20 10:47:13 +0100 | [diff] [blame] | 25 | #define AP_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */ |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 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 | |
Harald Freudenberger | bc4b295 | 2020-05-08 15:51:19 +0200 | [diff] [blame] | 31 | extern DECLARE_HASHTABLE(ap_queues, 8); |
| 32 | extern spinlock_t ap_queues_lock; |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 33 | |
Holger Dengler | 7501455 | 2012-08-28 16:41:50 +0200 | [diff] [blame] | 34 | static inline int ap_test_bit(unsigned int *ptr, unsigned int nr) |
Holger Dengler | 6bed05b | 2011-07-24 10:48:25 +0200 | [diff] [blame] | 35 | { |
Holger Dengler | 7501455 | 2012-08-28 16:41:50 +0200 | [diff] [blame] | 36 | return (*ptr & (0x80000000u >> nr)) != 0; |
Holger Dengler | 6bed05b | 2011-07-24 10:48:25 +0200 | [diff] [blame] | 37 | } |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 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 |
Felix Beck | cb17a63 | 2008-12-25 13:38:41 +0100 | [diff] [blame] | 45 | #define AP_RESPONSE_INVALID_ADDRESS 0x06 |
| 46 | #define AP_RESPONSE_OTHERWISE_CHANGED 0x07 |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 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 |
Felix Beck | a6a5d73 | 2009-12-07 12:51:55 +0100 | [diff] [blame] | 52 | #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16 |
Harald Freudenberger | e033262 | 2020-08-04 09:27:47 +0200 | [diff] [blame] | 53 | #define AP_RESPONSE_INVALID_DOMAIN 0x42 |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 54 | |
Felix Beck | 1749a81 | 2008-04-17 07:46:28 +0200 | [diff] [blame] | 55 | /* |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 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 |
Felix Beck | ffda4f7 | 2009-12-07 12:51:56 +0100 | [diff] [blame] | 63 | #define AP_DEVICE_TYPE_CEX3A 8 |
| 64 | #define AP_DEVICE_TYPE_CEX3C 9 |
Holger Dengler | 1e2076f | 2012-08-28 16:48:29 +0200 | [diff] [blame] | 65 | #define AP_DEVICE_TYPE_CEX4 10 |
Ingo Tuchscherer | bdea1f1b | 2015-01-23 14:56:25 +0100 | [diff] [blame] | 66 | #define AP_DEVICE_TYPE_CEX5 11 |
Harald Freudenberger | b3e8652 | 2016-10-12 15:58:14 +0200 | [diff] [blame] | 67 | #define AP_DEVICE_TYPE_CEX6 12 |
Harald Freudenberger | cf2957f | 2019-08-16 11:05:58 +0200 | [diff] [blame] | 68 | #define AP_DEVICE_TYPE_CEX7 13 |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 69 | |
Felix Beck | 1749a81 | 2008-04-17 07:46:28 +0200 | [diff] [blame] | 70 | /* |
Holger Dengler | b26bd94 | 2012-08-28 16:43:48 +0200 | [diff] [blame] | 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 |
Ingo Tuchscherer | 91f3e3ea | 2013-11-20 10:47:13 +0100 | [diff] [blame] | 77 | #define AP_FUNC_EP11 5 |
| 78 | #define AP_FUNC_APXA 6 |
Holger Dengler | b26bd94 | 2012-08-28 16:43:48 +0200 | [diff] [blame] | 79 | |
| 80 | /* |
Ingo Tuchscherer | c50a160 | 2015-06-17 16:19:15 +0200 | [diff] [blame] | 81 | * AP interrupt states |
| 82 | */ |
| 83 | #define AP_INTR_DISABLED 0 /* AP interrupt disabled */ |
| 84 | #define AP_INTR_ENABLED 1 /* AP interrupt enabled */ |
Martin Schwidefsky | 3f3007a | 2015-09-14 17:01:23 +0200 | [diff] [blame] | 85 | |
| 86 | /* |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 87 | * AP queue state machine states |
Martin Schwidefsky | 3f3007a | 2015-09-14 17:01:23 +0200 | [diff] [blame] | 88 | */ |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 89 | enum ap_sm_state { |
Harald Freudenberger | 0b641cb | 2020-07-02 11:22:01 +0200 | [diff] [blame] | 90 | AP_SM_STATE_RESET_START = 0, |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 91 | AP_SM_STATE_RESET_WAIT, |
| 92 | AP_SM_STATE_SETIRQ_WAIT, |
| 93 | AP_SM_STATE_IDLE, |
| 94 | AP_SM_STATE_WORKING, |
| 95 | AP_SM_STATE_QUEUE_FULL, |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 96 | NR_AP_SM_STATES |
Martin Schwidefsky | 3f3007a | 2015-09-14 17:01:23 +0200 | [diff] [blame] | 97 | }; |
| 98 | |
| 99 | /* |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 100 | * AP queue state machine events |
Martin Schwidefsky | 3f3007a | 2015-09-14 17:01:23 +0200 | [diff] [blame] | 101 | */ |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 102 | enum ap_sm_event { |
| 103 | AP_SM_EVENT_POLL, |
| 104 | AP_SM_EVENT_TIMEOUT, |
| 105 | NR_AP_SM_EVENTS |
Martin Schwidefsky | 3f3007a | 2015-09-14 17:01:23 +0200 | [diff] [blame] | 106 | }; |
| 107 | |
| 108 | /* |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 109 | * AP queue state wait behaviour |
Martin Schwidefsky | 3f3007a | 2015-09-14 17:01:23 +0200 | [diff] [blame] | 110 | */ |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 111 | enum ap_sm_wait { |
| 112 | AP_SM_WAIT_AGAIN, /* retry immediately */ |
| 113 | AP_SM_WAIT_TIMEOUT, /* wait for timeout */ |
| 114 | AP_SM_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */ |
| 115 | AP_SM_WAIT_NONE, /* no wait */ |
| 116 | NR_AP_SM_WAIT |
Martin Schwidefsky | 3f3007a | 2015-09-14 17:01:23 +0200 | [diff] [blame] | 117 | }; |
Ralph Wuerthner | af512ed0 | 2007-07-10 11:24:19 +0200 | [diff] [blame] | 118 | |
Harald Freudenberger | 0b641cb | 2020-07-02 11:22:01 +0200 | [diff] [blame] | 119 | /* |
| 120 | * AP queue device states |
| 121 | */ |
| 122 | enum ap_dev_state { |
| 123 | AP_DEV_STATE_UNINITIATED = 0, /* fresh and virgin, not touched */ |
| 124 | AP_DEV_STATE_OPERATING, /* queue dev is working normal */ |
| 125 | AP_DEV_STATE_SHUTDOWN, /* remove/unbind/shutdown in progress */ |
| 126 | AP_DEV_STATE_ERROR, /* device is in error state */ |
| 127 | NR_AP_DEV_STATES |
| 128 | }; |
| 129 | |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 130 | struct ap_device; |
| 131 | struct ap_message; |
| 132 | |
Harald Freudenberger | 7e0bdbe | 2018-07-20 08:36:53 +0200 | [diff] [blame] | 133 | /* |
| 134 | * The ap driver struct includes a flags field which holds some info for |
| 135 | * the ap bus about the driver. Currently only one flag is supported and |
| 136 | * used: The DEFAULT flag marks an ap driver as a default driver which is |
| 137 | * used together with the apmask and aqmask whitelisting of the ap bus. |
| 138 | */ |
| 139 | #define AP_DRIVER_FLAG_DEFAULT 0x0001 |
| 140 | |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 141 | struct ap_driver { |
| 142 | struct device_driver driver; |
| 143 | struct ap_device_id *ids; |
Harald Freudenberger | 7e0bdbe | 2018-07-20 08:36:53 +0200 | [diff] [blame] | 144 | unsigned int flags; |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 145 | |
| 146 | int (*probe)(struct ap_device *); |
| 147 | void (*remove)(struct ap_device *); |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 148 | }; |
| 149 | |
| 150 | #define to_ap_drv(x) container_of((x), struct ap_driver, driver) |
| 151 | |
| 152 | int ap_driver_register(struct ap_driver *, struct module *, char *); |
| 153 | void ap_driver_unregister(struct ap_driver *); |
| 154 | |
| 155 | struct ap_device { |
| 156 | struct device device; |
| 157 | struct ap_driver *drv; /* Pointer to AP device driver. */ |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 158 | int device_type; /* AP device type. */ |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 159 | }; |
| 160 | |
| 161 | #define to_ap_dev(x) container_of((x), struct ap_device, device) |
| 162 | |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 163 | struct ap_card { |
| 164 | struct ap_device ap_dev; |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 165 | void *private; /* ap driver private pointer. */ |
| 166 | int raw_hwtype; /* AP raw hardware type. */ |
| 167 | unsigned int functions; /* AP device function bitfield. */ |
| 168 | int queue_depth; /* AP queue depth.*/ |
| 169 | int id; /* AP card number. */ |
Harald Freudenberger | 4f2fccc | 2020-07-02 16:57:00 +0200 | [diff] [blame] | 170 | bool config; /* configured state */ |
Harald Freudenberger | fcd98d4 | 2019-12-20 16:02:54 +0100 | [diff] [blame] | 171 | atomic64_t total_request_count; /* # requests ever for this AP device.*/ |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 172 | }; |
| 173 | |
| 174 | #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device) |
| 175 | |
| 176 | struct ap_queue { |
| 177 | struct ap_device ap_dev; |
Harald Freudenberger | bc4b295 | 2020-05-08 15:51:19 +0200 | [diff] [blame] | 178 | struct hlist_node hnode; /* Node for the ap_queues hashtable */ |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 179 | struct ap_card *card; /* Ptr to assoc. AP card. */ |
| 180 | spinlock_t lock; /* Per device lock. */ |
| 181 | void *private; /* ap driver private pointer. */ |
Harald Freudenberger | 0b641cb | 2020-07-02 11:22:01 +0200 | [diff] [blame] | 182 | enum ap_dev_state dev_state; /* queue device state */ |
Harald Freudenberger | 4f2fccc | 2020-07-02 16:57:00 +0200 | [diff] [blame] | 183 | bool config; /* configured state */ |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 184 | ap_qid_t qid; /* AP queue id. */ |
| 185 | int interrupt; /* indicate if interrupts are enabled */ |
| 186 | int queue_count; /* # messages currently on AP queue. */ |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 187 | int pendingq_count; /* # requests on pendingq list. */ |
| 188 | int requestq_count; /* # requests on requestq list. */ |
Harald Freudenberger | fcd98d4 | 2019-12-20 16:02:54 +0100 | [diff] [blame] | 189 | u64 total_request_count; /* # requests ever for this AP device.*/ |
Harald Freudenberger | ac2b96f | 2018-08-17 12:36:01 +0200 | [diff] [blame] | 190 | int request_timeout; /* Request timeout in jiffies. */ |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 191 | struct timer_list timeout; /* Timer for request timeouts. */ |
| 192 | struct list_head pendingq; /* List of message sent to AP queue. */ |
| 193 | struct list_head requestq; /* List of message yet to be sent. */ |
| 194 | struct ap_message *reply; /* Per device reply message. */ |
Harald Freudenberger | 0b641cb | 2020-07-02 11:22:01 +0200 | [diff] [blame] | 195 | enum ap_sm_state sm_state; /* ap queue state machine state */ |
Harald Freudenberger | 2ea2a60 | 2020-07-02 15:56:15 +0200 | [diff] [blame] | 196 | int last_err_rc; /* last error state response code */ |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 197 | }; |
| 198 | |
| 199 | #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device) |
| 200 | |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 201 | typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue); |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 202 | |
Harald Freudenberger | 27c4f67 | 2020-09-29 16:07:22 +0200 | [diff] [blame] | 203 | /* failure injection cmd struct */ |
| 204 | struct ap_fi { |
| 205 | union { |
| 206 | u16 cmd; /* fi flags + action */ |
| 207 | struct { |
| 208 | u8 flags; /* fi flags only */ |
| 209 | u8 action; /* fi action only */ |
| 210 | }; |
| 211 | }; |
| 212 | }; |
| 213 | |
| 214 | /* all currently known fi actions */ |
| 215 | enum ap_fi_actions { |
| 216 | AP_FI_ACTION_CCA_AGENT_FF = 0x01, |
| 217 | AP_FI_ACTION_CCA_DOM_INVAL = 0x02, |
| 218 | AP_FI_ACTION_NQAP_QID_INVAL = 0x03, |
| 219 | }; |
| 220 | |
| 221 | /* all currently known fi flags */ |
| 222 | enum ap_fi_flags { |
| 223 | AP_FI_FLAG_NO_RETRY = 0x01, |
| 224 | AP_FI_FLAG_TOGGLE_SPECIAL = 0x02, |
| 225 | }; |
| 226 | |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 227 | struct ap_message { |
| 228 | struct list_head list; /* Request queueing. */ |
| 229 | unsigned long long psmid; /* Message id. */ |
Harald Freudenberger | 74ecbef | 2020-04-30 12:23:29 +0200 | [diff] [blame] | 230 | void *msg; /* Pointer to message buffer. */ |
| 231 | unsigned int len; /* Message length. */ |
Harald Freudenberger | 27c4f67 | 2020-09-29 16:07:22 +0200 | [diff] [blame] | 232 | u16 flags; /* Flags, see AP_MSG_FLAG_xxx */ |
| 233 | struct ap_fi fi; /* Failure Injection cmd */ |
Martin Schwidefsky | f58fe33 | 2015-09-14 16:59:27 +0200 | [diff] [blame] | 234 | int rc; /* Return code for this message */ |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 235 | void *private; /* ap driver private pointer. */ |
Holger Dengler | 54a8f56 | 2012-05-16 14:08:22 +0200 | [diff] [blame] | 236 | /* receive is called from tasklet context */ |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 237 | void (*receive)(struct ap_queue *, struct ap_message *, |
Holger Dengler | 54a8f56 | 2012-05-16 14:08:22 +0200 | [diff] [blame] | 238 | struct ap_message *); |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 239 | }; |
| 240 | |
Harald Freudenberger | 27c4f67 | 2020-09-29 16:07:22 +0200 | [diff] [blame] | 241 | #define AP_MSG_FLAG_SPECIAL 1 /* flag msg as 'special' with NQAP */ |
Harald Freudenberger | 74ecbef | 2020-04-30 12:23:29 +0200 | [diff] [blame] | 242 | |
Felix Beck | 468ffdd | 2009-12-07 12:51:54 +0100 | [diff] [blame] | 243 | /** |
| 244 | * ap_init_message() - Initialize ap_message. |
| 245 | * Initialize a message before using. Otherwise this might result in |
| 246 | * unexpected behaviour. |
| 247 | */ |
| 248 | static inline void ap_init_message(struct ap_message *ap_msg) |
| 249 | { |
Harald Freudenberger | 89a0c0e | 2018-05-28 13:00:42 +0200 | [diff] [blame] | 250 | memset(ap_msg, 0, sizeof(*ap_msg)); |
| 251 | } |
| 252 | |
| 253 | /** |
| 254 | * ap_release_message() - Release ap_message. |
| 255 | * Releases all memory used internal within the ap_message struct |
| 256 | * Currently this is the message and private field. |
| 257 | */ |
| 258 | static inline void ap_release_message(struct ap_message *ap_msg) |
| 259 | { |
Waiman Long | 453431a | 2020-08-06 23:18:13 -0700 | [diff] [blame] | 260 | kfree_sensitive(ap_msg->msg); |
| 261 | kfree_sensitive(ap_msg->private); |
Felix Beck | 468ffdd | 2009-12-07 12:51:54 +0100 | [diff] [blame] | 262 | } |
| 263 | |
Felix Beck | 1749a81 | 2008-04-17 07:46:28 +0200 | [diff] [blame] | 264 | /* |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 265 | * Note: don't use ap_send/ap_recv after using ap_queue_message |
| 266 | * for the first time. Otherwise the ap message queue will get |
| 267 | * confused. |
| 268 | */ |
| 269 | int ap_send(ap_qid_t, unsigned long long, void *, size_t); |
| 270 | int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); |
| 271 | |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 272 | enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event); |
| 273 | enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event); |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 274 | |
Harald Freudenberger | 0b641cb | 2020-07-02 11:22:01 +0200 | [diff] [blame] | 275 | int ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg); |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 276 | void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg); |
| 277 | void ap_flush_queue(struct ap_queue *aq); |
| 278 | |
| 279 | void *ap_airq_ptr(void); |
Harald Freudenberger | dc4b6de | 2020-05-26 10:49:33 +0200 | [diff] [blame] | 280 | void ap_wait(enum ap_sm_wait wait); |
Kees Cook | cefbeb5 | 2017-10-25 03:27:37 -0700 | [diff] [blame] | 281 | void ap_request_timeout(struct timer_list *t); |
Holger Dengler | dabecb2 | 2012-09-10 21:34:26 +0200 | [diff] [blame] | 282 | void ap_bus_force_rescan(void); |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 283 | |
Harald Freudenberger | 7379e65 | 2019-05-21 13:50:09 +0200 | [diff] [blame] | 284 | int ap_test_config_usage_domain(unsigned int domain); |
| 285 | int ap_test_config_ctrl_domain(unsigned int domain); |
| 286 | |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 287 | void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg); |
| 288 | struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type); |
Harald Freudenberger | 01396a3 | 2019-02-22 17:24:11 +0100 | [diff] [blame] | 289 | void ap_queue_prepare_remove(struct ap_queue *aq); |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 290 | void ap_queue_remove(struct ap_queue *aq); |
Harald Freudenberger | 0c874cd | 2019-11-22 16:30:06 +0100 | [diff] [blame] | 291 | void ap_queue_init_state(struct ap_queue *aq); |
Ingo Tuchscherer | e28d2af | 2016-08-25 11:16:03 +0200 | [diff] [blame] | 292 | |
Harald Freudenberger | 9a56410 | 2017-10-16 12:28:35 +0200 | [diff] [blame] | 293 | struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type, |
| 294 | int comp_device_type, unsigned int functions); |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 295 | |
Harald Freudenberger | 00fab23 | 2018-09-17 16:18:41 +0200 | [diff] [blame] | 296 | struct ap_perms { |
| 297 | unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)]; |
| 298 | unsigned long apm[BITS_TO_LONGS(AP_DEVICES)]; |
| 299 | unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)]; |
| 300 | }; |
| 301 | extern struct ap_perms ap_perms; |
| 302 | extern struct mutex ap_perms_mutex; |
| 303 | |
Harald Freudenberger | 7e0bdbe | 2018-07-20 08:36:53 +0200 | [diff] [blame] | 304 | /* |
Harald Freudenberger | bc4b295 | 2020-05-08 15:51:19 +0200 | [diff] [blame] | 305 | * Get ap_queue device for this qid. |
| 306 | * Returns ptr to the struct ap_queue device or NULL if there |
| 307 | * was no ap_queue device with this qid found. When something is |
| 308 | * found, the reference count of the embedded device is increased. |
| 309 | * So the caller has to decrease the reference count after use |
| 310 | * with a call to put_device(&aq->ap_dev.device). |
| 311 | */ |
| 312 | struct ap_queue *ap_get_qdev(ap_qid_t qid); |
| 313 | |
| 314 | /* |
Harald Freudenberger | 7e0bdbe | 2018-07-20 08:36:53 +0200 | [diff] [blame] | 315 | * check APQN for owned/reserved by ap bus and default driver(s). |
| 316 | * Checks if this APQN is or will be in use by the ap bus |
| 317 | * and the default set of drivers. |
| 318 | * If yes, returns 1, if not returns 0. On error a negative |
| 319 | * errno value is returned. |
| 320 | */ |
| 321 | int ap_owned_by_def_drv(int card, int queue); |
| 322 | |
| 323 | /* |
| 324 | * check 'matrix' of APQNs for owned/reserved by ap bus and |
| 325 | * default driver(s). |
| 326 | * Checks if there is at least one APQN in the given 'matrix' |
| 327 | * marked as owned/reserved by the ap bus and default driver(s). |
| 328 | * If such an APQN is found the return value is 1, otherwise |
| 329 | * 0 is returned. On error a negative errno value is returned. |
| 330 | * The parameter apm is a bitmask which should be declared |
| 331 | * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is |
| 332 | * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS). |
| 333 | */ |
| 334 | int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm, |
| 335 | unsigned long *aqm); |
| 336 | |
Harald Freudenberger | 00fab23 | 2018-09-17 16:18:41 +0200 | [diff] [blame] | 337 | /* |
| 338 | * ap_parse_mask_str() - helper function to parse a bitmap string |
| 339 | * and clear/set the bits in the bitmap accordingly. The string may be |
| 340 | * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple |
| 341 | * overwriting the current content of the bitmap. Or as relative string |
| 342 | * like "+1-16,-32,-0x40,+128" where only single bits or ranges of |
| 343 | * bits are cleared or set. Distinction is done based on the very |
| 344 | * first character which may be '+' or '-' for the relative string |
| 345 | * and othewise assume to be an absolute value string. If parsing fails |
| 346 | * a negative errno value is returned. All arguments and bitmaps are |
| 347 | * big endian order. |
| 348 | */ |
| 349 | int ap_parse_mask_str(const char *str, |
| 350 | unsigned long *bitmap, int bits, |
| 351 | struct mutex *lock); |
| 352 | |
Martin Schwidefsky | 1534c38 | 2006-09-20 15:58:25 +0200 | [diff] [blame] | 353 | #endif /* _AP_BUS_H_ */ |