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