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 * 10 * Adjunct processor bus header file. 11 * 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) 15 * any later version. 16 * 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. 21 * 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. 25 */ 26 27 #ifndef _AP_BUS_H_ 28 #define _AP_BUS_H_ 29 30 #include <linux/device.h> 31 #include <linux/mod_devicetable.h> 32 #include <linux/types.h> 33 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. */ 40 41 extern int ap_domain_index; 42 43 /** 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). 46 */ 47 typedef unsigned int ap_qid_t; 48 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) 52 53 /** 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 58 * @pad: A 4 bit pad 59 * @int_enabled: Shows if interrupts are enabled for the AP 60 * @response_conde: Holds the 8 bit response code 61 * @pad2: A 16 bit pad 62 * 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. 66 */ 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; 75 }; 76 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 90 #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16 91 92 /* 93 * Known device types 94 */ 95 #define AP_DEVICE_TYPE_PCICC 3 96 #define AP_DEVICE_TYPE_PCICA 4 97 #define AP_DEVICE_TYPE_PCIXCC 5 98 #define AP_DEVICE_TYPE_CEX2A 6 99 #define AP_DEVICE_TYPE_CEX2C 7 100 #define AP_DEVICE_TYPE_CEX3A 8 101 #define AP_DEVICE_TYPE_CEX3C 9 102 103 /* 104 * AP reset flag states 105 */ 106 #define AP_RESET_IGNORE 0 /* request timeout will be ignored */ 107 #define AP_RESET_ARMED 1 /* request timeout timer is active */ 108 #define AP_RESET_DO 2 /* AP reset required */ 109 110 struct ap_device; 111 struct ap_message; 112 113 struct ap_driver { 114 struct device_driver driver; 115 struct ap_device_id *ids; 116 117 int (*probe)(struct ap_device *); 118 void (*remove)(struct ap_device *); 119 /* receive is called from tasklet context */ 120 void (*receive)(struct ap_device *, struct ap_message *, 121 struct ap_message *); 122 int request_timeout; /* request timeout in jiffies */ 123 }; 124 125 #define to_ap_drv(x) container_of((x), struct ap_driver, driver) 126 127 int ap_driver_register(struct ap_driver *, struct module *, char *); 128 void ap_driver_unregister(struct ap_driver *); 129 130 struct ap_device { 131 struct device device; 132 struct ap_driver *drv; /* Pointer to AP device driver. */ 133 spinlock_t lock; /* Per device lock. */ 134 struct list_head list; /* private list of all AP devices. */ 135 136 ap_qid_t qid; /* AP queue id. */ 137 int queue_depth; /* AP queue depth.*/ 138 int device_type; /* AP device type. */ 139 int unregistered; /* marks AP device as unregistered */ 140 struct timer_list timeout; /* Timer for request timeouts. */ 141 int reset; /* Reset required after req. timeout. */ 142 143 int queue_count; /* # messages currently on AP queue. */ 144 145 struct list_head pendingq; /* List of message sent to AP queue. */ 146 int pendingq_count; /* # requests on pendingq list. */ 147 struct list_head requestq; /* List of message yet to be sent. */ 148 int requestq_count; /* # requests on requestq list. */ 149 int total_request_count; /* # requests ever for this AP device. */ 150 151 struct ap_message *reply; /* Per device reply message. */ 152 153 void *private; /* ap driver private pointer. */ 154 }; 155 156 #define to_ap_dev(x) container_of((x), struct ap_device, device) 157 158 struct ap_message { 159 struct list_head list; /* Request queueing. */ 160 unsigned long long psmid; /* Message id. */ 161 void *message; /* Pointer to message buffer. */ 162 size_t length; /* Message length. */ 163 164 void *private; /* ap driver private pointer. */ 165 unsigned int special:1; /* Used for special commands. */ 166 }; 167 168 #define AP_DEVICE(dt) \ 169 .dev_type=(dt), \ 170 .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE, 171 172 /** 173 * ap_init_message() - Initialize ap_message. 174 * Initialize a message before using. Otherwise this might result in 175 * unexpected behaviour. 176 */ 177 static inline void ap_init_message(struct ap_message *ap_msg) 178 { 179 ap_msg->psmid = 0; 180 ap_msg->length = 0; 181 ap_msg->special = 0; 182 } 183 184 /* 185 * Note: don't use ap_send/ap_recv after using ap_queue_message 186 * for the first time. Otherwise the ap message queue will get 187 * confused. 188 */ 189 int ap_send(ap_qid_t, unsigned long long, void *, size_t); 190 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 191 192 void ap_queue_message(struct ap_device *ap_dev, struct ap_message *ap_msg); 193 void ap_cancel_message(struct ap_device *ap_dev, struct ap_message *ap_msg); 194 void ap_flush_queue(struct ap_device *ap_dev); 195 196 int ap_module_init(void); 197 void ap_module_exit(void); 198 199 #endif /* _AP_BUS_H_ */ 200