- patches.arch/s390-fate311926-ap-type10-toleration.patch:
[opensuse:kernel.git] / drivers / s390 / crypto / ap_bus.h
1 /*
2  * linux/drivers/s390/crypto/ap_bus.h
3  *
4  * Copyright (C) 2006 IBM Corporation
5  * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
6  *            Martin Schwidefsky <schwidefsky@de.ibm.com>
7  *            Ralph Wuerthner <rwuerthn@de.ibm.com>
8  *            Felix Beck <felix.beck@de.ibm.com>
9  *            Holger Dengler <hd@linux.vnet.ibm.com>
10  *
11  * Adjunct processor bus header file.
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2, or (at your option)
16  * any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26  */
27
28 #ifndef _AP_BUS_H_
29 #define _AP_BUS_H_
30
31 #include <linux/device.h>
32 #include <linux/mod_devicetable.h>
33 #include <linux/types.h>
34
35 #define AP_DEVICES 64           /* Number of AP devices. */
36 #define AP_DOMAINS 16           /* Number of AP domains. */
37 #define AP_MAX_RESET 90         /* Maximum number of resets. */
38 #define AP_RESET_TIMEOUT (HZ/2) /* Time in ticks for reset timeouts. */
39 #define AP_CONFIG_TIME 30       /* Time in seconds between AP bus rescans. */
40 #define AP_POLL_TIME 1          /* Time in ticks between receive polls. */
41
42 extern int ap_domain_index;
43
44 /**
45  * The ap_qid_t identifier of an ap queue. It contains a
46  * 6 bit device index and a 4 bit queue index (domain).
47  */
48 typedef unsigned int ap_qid_t;
49
50 #define AP_MKQID(_device,_queue) (((_device) & 63) << 8 | ((_queue) & 15))
51 #define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63)
52 #define AP_QID_QUEUE(_qid) ((_qid) & 15)
53
54 /**
55  * structy ap_queue_status - Holds the AP queue status.
56  * @queue_empty: Shows if queue is empty
57  * @replies_waiting: Waiting replies
58  * @queue_full: Is 1 if the queue is full
59  * @pad: A 4 bit pad
60  * @int_enabled: Shows if interrupts are enabled for the AP
61  * @response_conde: Holds the 8 bit response code
62  * @pad2: A 16 bit pad
63  *
64  * The ap queue status word is returned by all three AP functions
65  * (PQAP, NQAP and DQAP).  There's a set of flags in the first
66  * byte, followed by a 1 byte response code.
67  */
68 struct ap_queue_status {
69         unsigned int queue_empty        : 1;
70         unsigned int replies_waiting    : 1;
71         unsigned int queue_full         : 1;
72         unsigned int pad1               : 4;
73         unsigned int int_enabled        : 1;
74         unsigned int response_code      : 8;
75         unsigned int pad2               : 16;
76 };
77
78 #define AP_QUEUE_STATUS_INVALID \
79                 { 1, 1, 1, 0xF, 1, 0xFF, 0xFFFF }
80
81 static inline
82 int ap_queue_status_invalid_test(struct ap_queue_status *status)
83 {
84         struct ap_queue_status invalid = AP_QUEUE_STATUS_INVALID;
85         return !(memcmp(status, &invalid, sizeof(struct ap_queue_status)));
86 }
87
88 #define MAX_AP_FACILITY 31
89
90 static inline int test_ap_facility(unsigned int function, unsigned int nr)
91 {
92         if (nr > MAX_AP_FACILITY)
93                 return 0;
94         return function & (unsigned int)(0x80000000 >> nr);
95 }
96
97 #define AP_RESPONSE_NORMAL              0x00
98 #define AP_RESPONSE_Q_NOT_AVAIL         0x01
99 #define AP_RESPONSE_RESET_IN_PROGRESS   0x02
100 #define AP_RESPONSE_DECONFIGURED        0x03
101 #define AP_RESPONSE_CHECKSTOPPED        0x04
102 #define AP_RESPONSE_BUSY                0x05
103 #define AP_RESPONSE_INVALID_ADDRESS     0x06
104 #define AP_RESPONSE_OTHERWISE_CHANGED   0x07
105 #define AP_RESPONSE_Q_FULL              0x10
106 #define AP_RESPONSE_NO_PENDING_REPLY    0x10
107 #define AP_RESPONSE_INDEX_TOO_BIG       0x11
108 #define AP_RESPONSE_NO_FIRST_PART       0x13
109 #define AP_RESPONSE_MESSAGE_TOO_BIG     0x15
110 #define AP_RESPONSE_REQ_FAC_NOT_INST    0x16
111
112 /*
113  * Known device types
114  */
115 #define AP_DEVICE_TYPE_PCICC    3
116 #define AP_DEVICE_TYPE_PCICA    4
117 #define AP_DEVICE_TYPE_PCIXCC   5
118 #define AP_DEVICE_TYPE_CEX2A    6
119 #define AP_DEVICE_TYPE_CEX2C    7
120 #define AP_DEVICE_TYPE_CEX3A    8
121 #define AP_DEVICE_TYPE_CEX3C    9
122
123 /*
124  * AP reset flag states
125  */
126 #define AP_RESET_IGNORE 0       /* request timeout will be ignored */
127 #define AP_RESET_ARMED  1       /* request timeout timer is active */
128 #define AP_RESET_DO     2       /* AP reset required */
129
130 struct ap_device;
131 struct ap_message;
132
133 struct ap_driver {
134         struct device_driver driver;
135         struct ap_device_id *ids;
136
137         int (*probe)(struct ap_device *);
138         void (*remove)(struct ap_device *);
139         /* receive is called from tasklet context */
140         void (*receive)(struct ap_device *, struct ap_message *,
141                         struct ap_message *);
142         int request_timeout;            /* request timeout in jiffies */
143 };
144
145 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
146
147 int ap_driver_register(struct ap_driver *, struct module *, char *);
148 void ap_driver_unregister(struct ap_driver *);
149
150 struct ap_device {
151         struct device device;
152         struct ap_driver *drv;          /* Pointer to AP device driver. */
153         spinlock_t lock;                /* Per device lock. */
154         struct list_head list;          /* private list of all AP devices. */
155
156         ap_qid_t qid;                   /* AP queue id. */
157         int queue_depth;                /* AP queue depth.*/
158         int device_type;                /* AP device type. */
159         int unregistered;               /* marks AP device as unregistered */
160         struct timer_list timeout;      /* Timer for request timeouts. */
161         int reset;                      /* Reset required after req. timeout. */
162
163         int queue_count;                /* # messages currently on AP queue. */
164
165         struct list_head pendingq;      /* List of message sent to AP queue. */
166         int pendingq_count;             /* # requests on pendingq list. */
167         struct list_head requestq;      /* List of message yet to be sent. */
168         int requestq_count;             /* # requests on requestq list. */
169         int total_request_count;        /* # requests ever for this AP device. */
170
171         struct ap_message *reply;       /* Per device reply message. */
172
173         void *private;                  /* ap driver private pointer. */
174 };
175
176 #define to_ap_dev(x) container_of((x), struct ap_device, device)
177
178 struct ap_message {
179         struct list_head list;          /* Request queueing. */
180         unsigned long long psmid;       /* Message id. */
181         void *message;                  /* Pointer to message buffer. */
182         size_t length;                  /* Message length. */
183
184         void *private;                  /* ap driver private pointer. */
185         unsigned int special:1;         /* Used for special commands. */
186 };
187
188 #define AP_DEVICE(dt)                                   \
189         .dev_type=(dt),                                 \
190         .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE,
191
192 /**
193  * ap_init_message() - Initialize ap_message.
194  * Initialize a message before using. Otherwise this might result in
195  * unexpected behaviour.
196  */
197 extern inline void ap_init_message(struct ap_message *ap_msg)
198 {
199         ap_msg->psmid = 0;
200         ap_msg->length = 0;
201         ap_msg->special = 0;
202 }
203
204 /*
205  * Note: don't use ap_send/ap_recv after using ap_queue_message
206  * for the first time. Otherwise the ap message queue will get
207  * confused.
208  */
209 int ap_send(ap_qid_t, unsigned long long, void *, size_t);
210 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
211
212 void ap_queue_message(struct ap_device *ap_dev, struct ap_message *ap_msg);
213 void ap_cancel_message(struct ap_device *ap_dev, struct ap_message *ap_msg);
214 void ap_flush_queue(struct ap_device *ap_dev);
215
216 int ap_module_init(void);
217 void ap_module_exit(void);
218
219 int ap_4096_commands_available(ap_qid_t qid);
220
221 #endif /* _AP_BUS_H_ */