Commit | Line | Data |
---|---|---|
1534c382 MS |
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 | * | |
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 16 /* Number of AP domains. */ | |
35 | #define AP_MAX_RESET 90 /* Maximum number of resets. */ | |
af512ed0 | 36 | #define AP_RESET_TIMEOUT (HZ/2) /* Time in ticks for reset timeouts. */ |
1534c382 MS |
37 | #define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */ |
38 | #define AP_POLL_TIME 1 /* Time in ticks between receive polls. */ | |
39 | ||
40 | extern int ap_domain_index; | |
41 | ||
42 | /** | |
43 | * The ap_qid_t identifier of an ap queue. It contains a | |
44 | * 6 bit device index and a 4 bit queue index (domain). | |
45 | */ | |
46 | typedef unsigned int ap_qid_t; | |
47 | ||
48 | #define AP_MKQID(_device,_queue) (((_device) & 63) << 8 | ((_queue) & 15)) | |
49 | #define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63) | |
50 | #define AP_QID_QUEUE(_qid) ((_qid) & 15) | |
51 | ||
52 | /** | |
53 | * The ap queue status word is returned by all three AP functions | |
54 | * (PQAP, NQAP and DQAP). There's a set of flags in the first | |
55 | * byte, followed by a 1 byte response code. | |
56 | */ | |
57 | struct ap_queue_status { | |
58 | unsigned int queue_empty : 1; | |
59 | unsigned int replies_waiting : 1; | |
60 | unsigned int queue_full : 1; | |
61 | unsigned int pad1 : 5; | |
62 | unsigned int response_code : 8; | |
63 | unsigned int pad2 : 16; | |
64 | }; | |
65 | ||
66 | #define AP_RESPONSE_NORMAL 0x00 | |
67 | #define AP_RESPONSE_Q_NOT_AVAIL 0x01 | |
68 | #define AP_RESPONSE_RESET_IN_PROGRESS 0x02 | |
69 | #define AP_RESPONSE_DECONFIGURED 0x03 | |
70 | #define AP_RESPONSE_CHECKSTOPPED 0x04 | |
71 | #define AP_RESPONSE_BUSY 0x05 | |
72 | #define AP_RESPONSE_Q_FULL 0x10 | |
73 | #define AP_RESPONSE_NO_PENDING_REPLY 0x10 | |
74 | #define AP_RESPONSE_INDEX_TOO_BIG 0x11 | |
75 | #define AP_RESPONSE_NO_FIRST_PART 0x13 | |
76 | #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 | |
77 | ||
78 | /** | |
79 | * Known device types | |
80 | */ | |
81 | #define AP_DEVICE_TYPE_PCICC 3 | |
82 | #define AP_DEVICE_TYPE_PCICA 4 | |
83 | #define AP_DEVICE_TYPE_PCIXCC 5 | |
84 | #define AP_DEVICE_TYPE_CEX2A 6 | |
85 | #define AP_DEVICE_TYPE_CEX2C 7 | |
86 | ||
af512ed0 RW |
87 | /** |
88 | * AP reset flag states | |
89 | */ | |
90 | #define AP_RESET_IGNORE 0 /* request timeout will be ignored */ | |
91 | #define AP_RESET_ARMED 1 /* request timeout timer is active */ | |
92 | #define AP_RESET_DO 2 /* AP reset required */ | |
93 | ||
1534c382 MS |
94 | struct ap_device; |
95 | struct ap_message; | |
96 | ||
97 | struct ap_driver { | |
98 | struct device_driver driver; | |
99 | struct ap_device_id *ids; | |
100 | ||
101 | int (*probe)(struct ap_device *); | |
102 | void (*remove)(struct ap_device *); | |
103 | /* receive is called from tasklet context */ | |
104 | void (*receive)(struct ap_device *, struct ap_message *, | |
105 | struct ap_message *); | |
af512ed0 | 106 | int request_timeout; /* request timeout in jiffies */ |
1534c382 MS |
107 | }; |
108 | ||
109 | #define to_ap_drv(x) container_of((x), struct ap_driver, driver) | |
110 | ||
111 | int ap_driver_register(struct ap_driver *, struct module *, char *); | |
112 | void ap_driver_unregister(struct ap_driver *); | |
113 | ||
114 | struct ap_device { | |
115 | struct device device; | |
116 | struct ap_driver *drv; /* Pointer to AP device driver. */ | |
117 | spinlock_t lock; /* Per device lock. */ | |
cf352ce0 | 118 | struct list_head list; /* private list of all AP devices. */ |
1534c382 MS |
119 | |
120 | ap_qid_t qid; /* AP queue id. */ | |
121 | int queue_depth; /* AP queue depth.*/ | |
122 | int device_type; /* AP device type. */ | |
123 | int unregistered; /* marks AP device as unregistered */ | |
af512ed0 RW |
124 | struct timer_list timeout; /* Timer for request timeouts. */ |
125 | int reset; /* Reset required after req. timeout. */ | |
1534c382 MS |
126 | |
127 | int queue_count; /* # messages currently on AP queue. */ | |
128 | ||
129 | struct list_head pendingq; /* List of message sent to AP queue. */ | |
130 | int pendingq_count; /* # requests on pendingq list. */ | |
131 | struct list_head requestq; /* List of message yet to be sent. */ | |
132 | int requestq_count; /* # requests on requestq list. */ | |
133 | int total_request_count; /* # requests ever for this AP device. */ | |
134 | ||
135 | struct ap_message *reply; /* Per device reply message. */ | |
136 | ||
137 | void *private; /* ap driver private pointer. */ | |
138 | }; | |
139 | ||
140 | #define to_ap_dev(x) container_of((x), struct ap_device, device) | |
141 | ||
142 | struct ap_message { | |
143 | struct list_head list; /* Request queueing. */ | |
144 | unsigned long long psmid; /* Message id. */ | |
145 | void *message; /* Pointer to message buffer. */ | |
146 | size_t length; /* Message length. */ | |
147 | ||
148 | void *private; /* ap driver private pointer. */ | |
149 | }; | |
150 | ||
151 | #define AP_DEVICE(dt) \ | |
152 | .dev_type=(dt), \ | |
153 | .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE, | |
154 | ||
155 | /** | |
156 | * Note: don't use ap_send/ap_recv after using ap_queue_message | |
157 | * for the first time. Otherwise the ap message queue will get | |
158 | * confused. | |
159 | */ | |
160 | int ap_send(ap_qid_t, unsigned long long, void *, size_t); | |
161 | int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); | |
162 | ||
163 | void ap_queue_message(struct ap_device *ap_dev, struct ap_message *ap_msg); | |
164 | void ap_cancel_message(struct ap_device *ap_dev, struct ap_message *ap_msg); | |
165 | void ap_flush_queue(struct ap_device *ap_dev); | |
166 | ||
167 | int ap_module_init(void); | |
168 | void ap_module_exit(void); | |
169 | ||
170 | #endif /* _AP_BUS_H_ */ |