]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/s390/crypto/ap_bus.h
s390/zcrypt: Fix wrong dispatching for control domain CPRBs
[mirror_ubuntu-bionic-kernel.git] / drivers / s390 / crypto / ap_bus.h
CommitLineData
cf65c71d 1/* SPDX-License-Identifier: GPL-2.0+ */
1534c382 2/*
75014550 3 * Copyright IBM Corp. 2006, 2012
1534c382
MS
4 * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
5 * Martin Schwidefsky <schwidefsky@de.ibm.com>
6 * Ralph Wuerthner <rwuerthn@de.ibm.com>
cb17a636 7 * Felix Beck <felix.beck@de.ibm.com>
6bed05bc 8 * Holger Dengler <hd@linux.vnet.ibm.com>
1534c382
MS
9 *
10 * Adjunct processor bus header file.
1534c382
MS
11 */
12
13#ifndef _AP_BUS_H_
14#define _AP_BUS_H_
15
16#include <linux/device.h>
1534c382 17#include <linux/types.h>
d62a6fae 18#include <asm/isc.h>
e7fc5146 19#include <asm/ap.h>
1534c382 20
25a3af60 21#define AP_DEVICES 256 /* Number of AP devices. */
170387a8 22#define AP_DOMAINS 256 /* Number of AP domains. */
91f3e3ea 23#define AP_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */
1534c382
MS
24#define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */
25#define AP_POLL_TIME 1 /* Time in ticks between receive polls. */
26
27extern int ap_domain_index;
28
e28d2af4
IT
29extern spinlock_t ap_list_lock;
30extern struct list_head ap_card_list;
31
75014550 32static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
6bed05bc 33{
75014550 34 return (*ptr & (0x80000000u >> nr)) != 0;
6bed05bc 35}
1534c382
MS
36
37#define AP_RESPONSE_NORMAL 0x00
38#define AP_RESPONSE_Q_NOT_AVAIL 0x01
39#define AP_RESPONSE_RESET_IN_PROGRESS 0x02
40#define AP_RESPONSE_DECONFIGURED 0x03
41#define AP_RESPONSE_CHECKSTOPPED 0x04
42#define AP_RESPONSE_BUSY 0x05
cb17a636
FB
43#define AP_RESPONSE_INVALID_ADDRESS 0x06
44#define AP_RESPONSE_OTHERWISE_CHANGED 0x07
1534c382
MS
45#define AP_RESPONSE_Q_FULL 0x10
46#define AP_RESPONSE_NO_PENDING_REPLY 0x10
47#define AP_RESPONSE_INDEX_TOO_BIG 0x11
48#define AP_RESPONSE_NO_FIRST_PART 0x13
49#define AP_RESPONSE_MESSAGE_TOO_BIG 0x15
a6a5d73a 50#define AP_RESPONSE_REQ_FAC_NOT_INST 0x16
1534c382 51
1749a81d 52/*
1534c382
MS
53 * Known device types
54 */
55#define AP_DEVICE_TYPE_PCICC 3
56#define AP_DEVICE_TYPE_PCICA 4
57#define AP_DEVICE_TYPE_PCIXCC 5
58#define AP_DEVICE_TYPE_CEX2A 6
59#define AP_DEVICE_TYPE_CEX2C 7
ffda4f71
FB
60#define AP_DEVICE_TYPE_CEX3A 8
61#define AP_DEVICE_TYPE_CEX3C 9
1e2076f4 62#define AP_DEVICE_TYPE_CEX4 10
bdea1f1b 63#define AP_DEVICE_TYPE_CEX5 11
b3e8652b 64#define AP_DEVICE_TYPE_CEX6 12
1534c382 65
b26bd941
HD
66/*
67 * Known function facilities
68 */
69#define AP_FUNC_MEX4K 1
70#define AP_FUNC_CRT4K 2
71#define AP_FUNC_COPRO 3
72#define AP_FUNC_ACCEL 4
91f3e3ea
IT
73#define AP_FUNC_EP11 5
74#define AP_FUNC_APXA 6
b26bd941 75
c50a160c
IT
76/*
77 * AP interrupt states
78 */
79#define AP_INTR_DISABLED 0 /* AP interrupt disabled */
80#define AP_INTR_ENABLED 1 /* AP interrupt enabled */
3f3007af
MS
81
82/*
83 * AP device states
84 */
85enum ap_state {
86 AP_STATE_RESET_START,
87 AP_STATE_RESET_WAIT,
88 AP_STATE_SETIRQ_WAIT,
89 AP_STATE_IDLE,
90 AP_STATE_WORKING,
91 AP_STATE_QUEUE_FULL,
92 AP_STATE_SUSPEND_WAIT,
93 AP_STATE_BORKED,
94 NR_AP_STATES
95};
96
97/*
98 * AP device events
99 */
100enum ap_event {
101 AP_EVENT_POLL,
102 AP_EVENT_TIMEOUT,
103 NR_AP_EVENTS
104};
105
106/*
107 * AP wait behaviour
108 */
109enum ap_wait {
110 AP_WAIT_AGAIN, /* retry immediately */
111 AP_WAIT_TIMEOUT, /* wait for timeout */
112 AP_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */
113 AP_WAIT_NONE, /* no wait */
114 NR_AP_WAIT
115};
af512ed0 116
1534c382
MS
117struct ap_device;
118struct ap_message;
119
3cb86ad0
HF
120/*
121 * The ap driver struct includes a flags field which holds some info for
122 * the ap bus about the driver. Currently only one flag is supported and
123 * used: The DEFAULT flag marks an ap driver as a default driver which is
124 * used together with the apmask and aqmask whitelisting of the ap bus.
125 */
126#define AP_DRIVER_FLAG_DEFAULT 0x0001
127
1534c382
MS
128struct ap_driver {
129 struct device_driver driver;
130 struct ap_device_id *ids;
3cb86ad0 131 unsigned int flags;
1534c382
MS
132
133 int (*probe)(struct ap_device *);
134 void (*remove)(struct ap_device *);
e28d2af4
IT
135 void (*suspend)(struct ap_device *);
136 void (*resume)(struct ap_device *);
1534c382
MS
137};
138
139#define to_ap_drv(x) container_of((x), struct ap_driver, driver)
140
141int ap_driver_register(struct ap_driver *, struct module *, char *);
142void ap_driver_unregister(struct ap_driver *);
143
144struct ap_device {
145 struct device device;
146 struct ap_driver *drv; /* Pointer to AP device driver. */
e28d2af4
IT
147 int device_type; /* AP device type. */
148};
1534c382 149
e28d2af4 150#define to_ap_dev(x) container_of((x), struct ap_device, device)
3f3007af 151
e28d2af4
IT
152struct ap_card {
153 struct ap_device ap_dev;
154 struct list_head list; /* Private list of AP cards. */
155 struct list_head queues; /* List of assoc. AP queues */
156 void *private; /* ap driver private pointer. */
42f4dd61 157 int raw_hwtype; /* AP raw hardware type. */
b26bd941 158 unsigned int functions; /* AP device function bitfield. */
e28d2af4
IT
159 int queue_depth; /* AP queue depth.*/
160 int id; /* AP card number. */
e47de21d 161 atomic_t total_request_count; /* # requests ever for this AP device.*/
e28d2af4
IT
162};
163
164#define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
1534c382 165
e28d2af4
IT
166struct ap_queue {
167 struct ap_device ap_dev;
168 struct list_head list; /* Private list of AP queues. */
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. */
c50a160c 173 int interrupt; /* indicate if interrupts are enabled */
1534c382 174 int queue_count; /* # messages currently on AP queue. */
e28d2af4 175 enum ap_state state; /* State of the AP device. */
1534c382 176 int pendingq_count; /* # requests on pendingq list. */
1534c382 177 int requestq_count; /* # requests on requestq list. */
e47de21d 178 int total_request_count; /* # requests ever for this AP device.*/
cf65c71d 179 int request_timeout; /* Request timeout in jiffies. */
e28d2af4
IT
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. */
1534c382 183 struct ap_message *reply; /* Per device reply message. */
1534c382
MS
184};
185
e28d2af4
IT
186#define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
187
188typedef enum ap_wait (ap_func_t)(struct ap_queue *queue);
1534c382
MS
189
190struct ap_message {
191 struct list_head list; /* Request queueing. */
192 unsigned long long psmid; /* Message id. */
193 void *message; /* Pointer to message buffer. */
194 size_t length; /* Message length. */
f58fe336 195 int rc; /* Return code for this message */
1534c382
MS
196
197 void *private; /* ap driver private pointer. */
a6a5d73a 198 unsigned int special:1; /* Used for special commands. */
54a8f561 199 /* receive is called from tasklet context */
e28d2af4 200 void (*receive)(struct ap_queue *, struct ap_message *,
54a8f561 201 struct ap_message *);
1534c382
MS
202};
203
468ffddf
FB
204/**
205 * ap_init_message() - Initialize ap_message.
206 * Initialize a message before using. Otherwise this might result in
207 * unexpected behaviour.
208 */
209static inline void ap_init_message(struct ap_message *ap_msg)
210{
3f52b4d1
HF
211 memset(ap_msg, 0, sizeof(*ap_msg));
212}
213
214/**
215 * ap_release_message() - Release ap_message.
216 * Releases all memory used internal within the ap_message struct
217 * Currently this is the message and private field.
218 */
219static inline void ap_release_message(struct ap_message *ap_msg)
220{
221 kzfree(ap_msg->message);
222 kzfree(ap_msg->private);
468ffddf
FB
223}
224
e28d2af4
IT
225#define for_each_ap_card(_ac) \
226 list_for_each_entry(_ac, &ap_card_list, list)
227
228#define for_each_ap_queue(_aq, _ac) \
229 list_for_each_entry(_aq, &(_ac)->queues, list)
230
1749a81d 231/*
1534c382
MS
232 * Note: don't use ap_send/ap_recv after using ap_queue_message
233 * for the first time. Otherwise the ap message queue will get
234 * confused.
235 */
236int ap_send(ap_qid_t, unsigned long long, void *, size_t);
237int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
238
e28d2af4
IT
239enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event);
240enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event);
241
242void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
243void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
244void ap_flush_queue(struct ap_queue *aq);
245
246void *ap_airq_ptr(void);
247void ap_wait(enum ap_wait wait);
cefbeb5d 248void ap_request_timeout(struct timer_list *t);
dabecb29 249void ap_bus_force_rescan(void);
e28d2af4 250
c83450ad
HF
251int ap_test_config_usage_domain(unsigned int domain);
252int ap_test_config_ctrl_domain(unsigned int domain);
253
e28d2af4
IT
254void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
255struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
256void ap_queue_remove(struct ap_queue *aq);
257void ap_queue_suspend(struct ap_device *ap_dev);
258void ap_queue_resume(struct ap_device *ap_dev);
de43b416 259void ap_queue_reinit_state(struct ap_queue *aq);
e28d2af4 260
9a564108
HF
261struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type,
262 int comp_device_type, unsigned int functions);
1534c382 263
3cb86ad0
HF
264/*
265 * check APQN for owned/reserved by ap bus and default driver(s).
266 * Checks if this APQN is or will be in use by the ap bus
267 * and the default set of drivers.
268 * If yes, returns 1, if not returns 0. On error a negative
269 * errno value is returned.
270 */
271int ap_owned_by_def_drv(int card, int queue);
272
273/*
274 * check 'matrix' of APQNs for owned/reserved by ap bus and
275 * default driver(s).
276 * Checks if there is at least one APQN in the given 'matrix'
277 * marked as owned/reserved by the ap bus and default driver(s).
278 * If such an APQN is found the return value is 1, otherwise
279 * 0 is returned. On error a negative errno value is returned.
280 * The parameter apm is a bitmask which should be declared
281 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
282 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
283 */
284int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm,
285 unsigned long *aqm);
286
1534c382 287#endif /* _AP_BUS_H_ */