xref: /openbmc/linux/drivers/s390/crypto/ap_bus.h (revision 0edbfea5)
1 /*
2  * Copyright IBM Corp. 2006, 2012
3  * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
4  *	      Martin Schwidefsky <schwidefsky@de.ibm.com>
5  *	      Ralph Wuerthner <rwuerthn@de.ibm.com>
6  *	      Felix Beck <felix.beck@de.ibm.com>
7  *	      Holger Dengler <hd@linux.vnet.ibm.com>
8  *
9  * Adjunct processor bus header file.
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2, or (at your option)
14  * any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  */
25 
26 #ifndef _AP_BUS_H_
27 #define _AP_BUS_H_
28 
29 #include <linux/device.h>
30 #include <linux/mod_devicetable.h>
31 #include <linux/types.h>
32 
33 #define AP_DEVICES 64		/* Number of AP devices. */
34 #define AP_DOMAINS 256		/* Number of AP domains. */
35 #define AP_RESET_TIMEOUT (HZ*0.7)	/* Time in ticks for reset timeouts. */
36 #define AP_CONFIG_TIME 30	/* Time in seconds between AP bus rescans. */
37 #define AP_POLL_TIME 1		/* Time in ticks between receive polls. */
38 
39 extern int ap_domain_index;
40 
41 /**
42  * The ap_qid_t identifier of an ap queue. It contains a
43  * 6 bit device index and a 4 bit queue index (domain).
44  */
45 typedef unsigned int ap_qid_t;
46 
47 #define AP_MKQID(_device, _queue) (((_device) & 63) << 8 | ((_queue) & 255))
48 #define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63)
49 #define AP_QID_QUEUE(_qid) ((_qid) & 255)
50 
51 /**
52  * structy ap_queue_status - Holds the AP queue status.
53  * @queue_empty: Shows if queue is empty
54  * @replies_waiting: Waiting replies
55  * @queue_full: Is 1 if the queue is full
56  * @pad: A 4 bit pad
57  * @int_enabled: Shows if interrupts are enabled for the AP
58  * @response_conde: Holds the 8 bit response code
59  * @pad2: A 16 bit pad
60  *
61  * The ap queue status word is returned by all three AP functions
62  * (PQAP, NQAP and DQAP).  There's a set of flags in the first
63  * byte, followed by a 1 byte response code.
64  */
65 struct ap_queue_status {
66 	unsigned int queue_empty	: 1;
67 	unsigned int replies_waiting	: 1;
68 	unsigned int queue_full		: 1;
69 	unsigned int pad1		: 4;
70 	unsigned int int_enabled	: 1;
71 	unsigned int response_code	: 8;
72 	unsigned int pad2		: 16;
73 } __packed;
74 
75 
76 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
77 {
78 	return (*ptr & (0x80000000u >> nr)) != 0;
79 }
80 
81 #define AP_RESPONSE_NORMAL		0x00
82 #define AP_RESPONSE_Q_NOT_AVAIL		0x01
83 #define AP_RESPONSE_RESET_IN_PROGRESS	0x02
84 #define AP_RESPONSE_DECONFIGURED	0x03
85 #define AP_RESPONSE_CHECKSTOPPED	0x04
86 #define AP_RESPONSE_BUSY		0x05
87 #define AP_RESPONSE_INVALID_ADDRESS	0x06
88 #define AP_RESPONSE_OTHERWISE_CHANGED	0x07
89 #define AP_RESPONSE_Q_FULL		0x10
90 #define AP_RESPONSE_NO_PENDING_REPLY	0x10
91 #define AP_RESPONSE_INDEX_TOO_BIG	0x11
92 #define AP_RESPONSE_NO_FIRST_PART	0x13
93 #define AP_RESPONSE_MESSAGE_TOO_BIG	0x15
94 #define AP_RESPONSE_REQ_FAC_NOT_INST	0x16
95 
96 /*
97  * Known device types
98  */
99 #define AP_DEVICE_TYPE_PCICC	3
100 #define AP_DEVICE_TYPE_PCICA	4
101 #define AP_DEVICE_TYPE_PCIXCC	5
102 #define AP_DEVICE_TYPE_CEX2A	6
103 #define AP_DEVICE_TYPE_CEX2C	7
104 #define AP_DEVICE_TYPE_CEX3A	8
105 #define AP_DEVICE_TYPE_CEX3C	9
106 #define AP_DEVICE_TYPE_CEX4	10
107 #define AP_DEVICE_TYPE_CEX5	11
108 
109 /*
110  * Known function facilities
111  */
112 #define AP_FUNC_MEX4K 1
113 #define AP_FUNC_CRT4K 2
114 #define AP_FUNC_COPRO 3
115 #define AP_FUNC_ACCEL 4
116 #define AP_FUNC_EP11  5
117 #define AP_FUNC_APXA  6
118 
119 /*
120  * AP interrupt states
121  */
122 #define AP_INTR_DISABLED	0	/* AP interrupt disabled */
123 #define AP_INTR_ENABLED		1	/* AP interrupt enabled */
124 
125 /*
126  * AP device states
127  */
128 enum ap_state {
129 	AP_STATE_RESET_START,
130 	AP_STATE_RESET_WAIT,
131 	AP_STATE_SETIRQ_WAIT,
132 	AP_STATE_IDLE,
133 	AP_STATE_WORKING,
134 	AP_STATE_QUEUE_FULL,
135 	AP_STATE_SUSPEND_WAIT,
136 	AP_STATE_BORKED,
137 	NR_AP_STATES
138 };
139 
140 /*
141  * AP device events
142  */
143 enum ap_event {
144 	AP_EVENT_POLL,
145 	AP_EVENT_TIMEOUT,
146 	NR_AP_EVENTS
147 };
148 
149 /*
150  * AP wait behaviour
151  */
152 enum ap_wait {
153 	AP_WAIT_AGAIN,		/* retry immediately */
154 	AP_WAIT_TIMEOUT,	/* wait for timeout */
155 	AP_WAIT_INTERRUPT,	/* wait for thin interrupt (if available) */
156 	AP_WAIT_NONE,		/* no wait */
157 	NR_AP_WAIT
158 };
159 
160 struct ap_device;
161 struct ap_message;
162 
163 struct ap_driver {
164 	struct device_driver driver;
165 	struct ap_device_id *ids;
166 
167 	int (*probe)(struct ap_device *);
168 	void (*remove)(struct ap_device *);
169 	int request_timeout;		/* request timeout in jiffies */
170 };
171 
172 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
173 
174 int ap_driver_register(struct ap_driver *, struct module *, char *);
175 void ap_driver_unregister(struct ap_driver *);
176 
177 typedef enum ap_wait (ap_func_t)(struct ap_device *ap_dev);
178 
179 struct ap_device {
180 	struct device device;
181 	struct ap_driver *drv;		/* Pointer to AP device driver. */
182 	spinlock_t lock;		/* Per device lock. */
183 	struct list_head list;		/* private list of all AP devices. */
184 
185 	enum ap_state state;		/* State of the AP device. */
186 
187 	ap_qid_t qid;			/* AP queue id. */
188 	int queue_depth;		/* AP queue depth.*/
189 	int device_type;		/* AP device type. */
190 	int raw_hwtype;			/* AP raw hardware type. */
191 	unsigned int functions;		/* AP device function bitfield. */
192 	struct timer_list timeout;	/* Timer for request timeouts. */
193 
194 	int interrupt;			/* indicate if interrupts are enabled */
195 	int queue_count;		/* # messages currently on AP queue. */
196 
197 	struct list_head pendingq;	/* List of message sent to AP queue. */
198 	int pendingq_count;		/* # requests on pendingq list. */
199 	struct list_head requestq;	/* List of message yet to be sent. */
200 	int requestq_count;		/* # requests on requestq list. */
201 	int total_request_count;	/* # requests ever for this AP device. */
202 
203 	struct ap_message *reply;	/* Per device reply message. */
204 
205 	void *private;			/* ap driver private pointer. */
206 };
207 
208 #define to_ap_dev(x) container_of((x), struct ap_device, device)
209 
210 struct ap_message {
211 	struct list_head list;		/* Request queueing. */
212 	unsigned long long psmid;	/* Message id. */
213 	void *message;			/* Pointer to message buffer. */
214 	size_t length;			/* Message length. */
215 	int rc;				/* Return code for this message */
216 
217 	void *private;			/* ap driver private pointer. */
218 	unsigned int special:1;		/* Used for special commands. */
219 	/* receive is called from tasklet context */
220 	void (*receive)(struct ap_device *, struct ap_message *,
221 			struct ap_message *);
222 };
223 
224 struct ap_config_info {
225 	unsigned int special_command:1;
226 	unsigned int ap_extended:1;
227 	unsigned char reserved1:6;
228 	unsigned char reserved2[15];
229 	unsigned int apm[8];		/* AP ID mask */
230 	unsigned int aqm[8];		/* AP queue mask */
231 	unsigned int adm[8];		/* AP domain mask */
232 	unsigned char reserved4[16];
233 } __packed;
234 
235 #define AP_DEVICE(dt)					\
236 	.dev_type=(dt),					\
237 	.match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE,
238 
239 /**
240  * ap_init_message() - Initialize ap_message.
241  * Initialize a message before using. Otherwise this might result in
242  * unexpected behaviour.
243  */
244 static inline void ap_init_message(struct ap_message *ap_msg)
245 {
246 	ap_msg->psmid = 0;
247 	ap_msg->length = 0;
248 	ap_msg->rc = 0;
249 	ap_msg->special = 0;
250 	ap_msg->receive = NULL;
251 }
252 
253 /*
254  * Note: don't use ap_send/ap_recv after using ap_queue_message
255  * for the first time. Otherwise the ap message queue will get
256  * confused.
257  */
258 int ap_send(ap_qid_t, unsigned long long, void *, size_t);
259 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
260 
261 void ap_queue_message(struct ap_device *ap_dev, struct ap_message *ap_msg);
262 void ap_cancel_message(struct ap_device *ap_dev, struct ap_message *ap_msg);
263 void ap_flush_queue(struct ap_device *ap_dev);
264 void ap_bus_force_rescan(void);
265 
266 int ap_module_init(void);
267 void ap_module_exit(void);
268 
269 #endif /* _AP_BUS_H_ */
270