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