]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/s390/crypto/ap_bus.h
2 * linux/drivers/s390/crypto/ap_bus.h
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>
10 * Adjunct processor bus header file.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30 #include <linux/device.h>
31 #include <linux/mod_devicetable.h>
32 #include <linux/types.h>
34 #define AP_DEVICES 64 /* Number of AP devices. */
35 #define AP_DOMAINS 16 /* Number of AP domains. */
36 #define AP_MAX_RESET 90 /* Maximum number of resets. */
37 #define AP_RESET_TIMEOUT (HZ/2) /* Time in ticks for reset timeouts. */
38 #define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */
39 #define AP_POLL_TIME 1 /* Time in ticks between receive polls. */
41 extern int ap_domain_index
;
44 * The ap_qid_t identifier of an ap queue. It contains a
45 * 6 bit device index and a 4 bit queue index (domain).
47 typedef unsigned int ap_qid_t
;
49 #define AP_MKQID(_device,_queue) (((_device) & 63) << 8 | ((_queue) & 15))
50 #define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63)
51 #define AP_QID_QUEUE(_qid) ((_qid) & 15)
54 * structy ap_queue_status - Holds the AP queue status.
55 * @queue_empty: Shows if queue is empty
56 * @replies_waiting: Waiting replies
57 * @queue_full: Is 1 if the queue is full
59 * @int_enabled: Shows if interrupts are enabled for the AP
60 * @response_conde: Holds the 8 bit response code
63 * The ap queue status word is returned by all three AP functions
64 * (PQAP, NQAP and DQAP). There's a set of flags in the first
65 * byte, followed by a 1 byte response code.
67 struct ap_queue_status
{
68 unsigned int queue_empty
: 1;
69 unsigned int replies_waiting
: 1;
70 unsigned int queue_full
: 1;
71 unsigned int pad1
: 4;
72 unsigned int int_enabled
: 1;
73 unsigned int response_code
: 8;
74 unsigned int pad2
: 16;
77 #define AP_RESPONSE_NORMAL 0x00
78 #define AP_RESPONSE_Q_NOT_AVAIL 0x01
79 #define AP_RESPONSE_RESET_IN_PROGRESS 0x02
80 #define AP_RESPONSE_DECONFIGURED 0x03
81 #define AP_RESPONSE_CHECKSTOPPED 0x04
82 #define AP_RESPONSE_BUSY 0x05
83 #define AP_RESPONSE_INVALID_ADDRESS 0x06
84 #define AP_RESPONSE_OTHERWISE_CHANGED 0x07
85 #define AP_RESPONSE_Q_FULL 0x10
86 #define AP_RESPONSE_NO_PENDING_REPLY 0x10
87 #define AP_RESPONSE_INDEX_TOO_BIG 0x11
88 #define AP_RESPONSE_NO_FIRST_PART 0x13
89 #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15
94 #define AP_DEVICE_TYPE_PCICC 3
95 #define AP_DEVICE_TYPE_PCICA 4
96 #define AP_DEVICE_TYPE_PCIXCC 5
97 #define AP_DEVICE_TYPE_CEX2A 6
98 #define AP_DEVICE_TYPE_CEX2C 7
99 #define AP_DEVICE_TYPE_CEX2A2 8
100 #define AP_DEVICE_TYPE_CEX2C2 9
103 * AP reset flag states
105 #define AP_RESET_IGNORE 0 /* request timeout will be ignored */
106 #define AP_RESET_ARMED 1 /* request timeout timer is active */
107 #define AP_RESET_DO 2 /* AP reset required */
113 struct device_driver driver
;
114 struct ap_device_id
*ids
;
116 int (*probe
)(struct ap_device
*);
117 void (*remove
)(struct ap_device
*);
118 /* receive is called from tasklet context */
119 void (*receive
)(struct ap_device
*, struct ap_message
*,
120 struct ap_message
*);
121 int request_timeout
; /* request timeout in jiffies */
124 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
126 int ap_driver_register(struct ap_driver
*, struct module
*, char *);
127 void ap_driver_unregister(struct ap_driver
*);
130 struct device device
;
131 struct ap_driver
*drv
; /* Pointer to AP device driver. */
132 spinlock_t lock
; /* Per device lock. */
133 struct list_head list
; /* private list of all AP devices. */
135 ap_qid_t qid
; /* AP queue id. */
136 int queue_depth
; /* AP queue depth.*/
137 int device_type
; /* AP device type. */
138 int unregistered
; /* marks AP device as unregistered */
139 struct timer_list timeout
; /* Timer for request timeouts. */
140 int reset
; /* Reset required after req. timeout. */
142 int queue_count
; /* # messages currently on AP queue. */
144 struct list_head pendingq
; /* List of message sent to AP queue. */
145 int pendingq_count
; /* # requests on pendingq list. */
146 struct list_head requestq
; /* List of message yet to be sent. */
147 int requestq_count
; /* # requests on requestq list. */
148 int total_request_count
; /* # requests ever for this AP device. */
150 struct ap_message
*reply
; /* Per device reply message. */
152 void *private; /* ap driver private pointer. */
155 #define to_ap_dev(x) container_of((x), struct ap_device, device)
158 struct list_head list
; /* Request queueing. */
159 unsigned long long psmid
; /* Message id. */
160 void *message
; /* Pointer to message buffer. */
161 size_t length
; /* Message length. */
163 void *private; /* ap driver private pointer. */
166 #define AP_DEVICE(dt) \
168 .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE,
171 * Note: don't use ap_send/ap_recv after using ap_queue_message
172 * for the first time. Otherwise the ap message queue will get
175 int ap_send(ap_qid_t
, unsigned long long, void *, size_t);
176 int ap_recv(ap_qid_t
, unsigned long long *, void *, size_t);
178 void ap_queue_message(struct ap_device
*ap_dev
, struct ap_message
*ap_msg
);
179 void ap_cancel_message(struct ap_device
*ap_dev
, struct ap_message
*ap_msg
);
180 void ap_flush_queue(struct ap_device
*ap_dev
);
182 int ap_module_init(void);
183 void ap_module_exit(void);
185 #endif /* _AP_BUS_H_ */