1 /* 2 * Copyright IBM Corp. 2006, 2012 3 * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com> 4 * Martin Schwidefsky <schwidefsky@de.ibm.com> 5 * Ralph Wuerthner <rwuerthn@de.ibm.com> 6 * Felix Beck <felix.beck@de.ibm.com> 7 * Holger Dengler <hd@linux.vnet.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 256 /* Number of AP domains. */ 35 #define AP_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */ 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 #define AP_POLL_IMMEDIATELY 1 /* continue running poll tasklet */ 40 #define AP_POLL_AFTER_TIMEOUT 2 /* run poll tasklet again after timout */ 41 42 extern int ap_domain_index; 43 44 /** 45 * The ap_qid_t identifier of an ap queue. It contains a 46 * 6 bit device index and a 4 bit queue index (domain). 47 */ 48 typedef unsigned int ap_qid_t; 49 50 #define AP_MKQID(_device, _queue) (((_device) & 63) << 8 | ((_queue) & 255)) 51 #define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63) 52 #define AP_QID_QUEUE(_qid) ((_qid) & 255) 53 54 /** 55 * structy ap_queue_status - Holds the AP queue status. 56 * @queue_empty: Shows if queue is empty 57 * @replies_waiting: Waiting replies 58 * @queue_full: Is 1 if the queue is full 59 * @pad: A 4 bit pad 60 * @int_enabled: Shows if interrupts are enabled for the AP 61 * @response_conde: Holds the 8 bit response code 62 * @pad2: A 16 bit pad 63 * 64 * The ap queue status word is returned by all three AP functions 65 * (PQAP, NQAP and DQAP). There's a set of flags in the first 66 * byte, followed by a 1 byte response code. 67 */ 68 struct ap_queue_status { 69 unsigned int queue_empty : 1; 70 unsigned int replies_waiting : 1; 71 unsigned int queue_full : 1; 72 unsigned int pad1 : 4; 73 unsigned int int_enabled : 1; 74 unsigned int response_code : 8; 75 unsigned int pad2 : 16; 76 } __packed; 77 78 #define AP_QUEUE_STATUS_INVALID \ 79 { 1, 1, 1, 0xF, 1, 0xFF, 0xFFFF } 80 81 static inline 82 int ap_queue_status_invalid_test(struct ap_queue_status *status) 83 { 84 struct ap_queue_status invalid = AP_QUEUE_STATUS_INVALID; 85 return !(memcmp(status, &invalid, sizeof(struct ap_queue_status))); 86 } 87 88 #define AP_MAX_BITS 31 89 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr) 90 { 91 if (nr > AP_MAX_BITS) 92 return 0; 93 return (*ptr & (0x80000000u >> nr)) != 0; 94 } 95 96 #define AP_RESPONSE_NORMAL 0x00 97 #define AP_RESPONSE_Q_NOT_AVAIL 0x01 98 #define AP_RESPONSE_RESET_IN_PROGRESS 0x02 99 #define AP_RESPONSE_DECONFIGURED 0x03 100 #define AP_RESPONSE_CHECKSTOPPED 0x04 101 #define AP_RESPONSE_BUSY 0x05 102 #define AP_RESPONSE_INVALID_ADDRESS 0x06 103 #define AP_RESPONSE_OTHERWISE_CHANGED 0x07 104 #define AP_RESPONSE_Q_FULL 0x10 105 #define AP_RESPONSE_NO_PENDING_REPLY 0x10 106 #define AP_RESPONSE_INDEX_TOO_BIG 0x11 107 #define AP_RESPONSE_NO_FIRST_PART 0x13 108 #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 109 #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16 110 111 /* 112 * Known device types 113 */ 114 #define AP_DEVICE_TYPE_PCICC 3 115 #define AP_DEVICE_TYPE_PCICA 4 116 #define AP_DEVICE_TYPE_PCIXCC 5 117 #define AP_DEVICE_TYPE_CEX2A 6 118 #define AP_DEVICE_TYPE_CEX2C 7 119 #define AP_DEVICE_TYPE_CEX3A 8 120 #define AP_DEVICE_TYPE_CEX3C 9 121 #define AP_DEVICE_TYPE_CEX4 10 122 #define AP_DEVICE_TYPE_CEX5 11 123 124 /* 125 * Known function facilities 126 */ 127 #define AP_FUNC_MEX4K 1 128 #define AP_FUNC_CRT4K 2 129 #define AP_FUNC_COPRO 3 130 #define AP_FUNC_ACCEL 4 131 #define AP_FUNC_EP11 5 132 #define AP_FUNC_APXA 6 133 134 /* 135 * AP reset flag states 136 */ 137 #define AP_RESET_IGNORE 0 /* request timeout will be ignored */ 138 #define AP_RESET_ARMED 1 /* request timeout timer is active */ 139 #define AP_RESET_DO 2 /* AP reset required */ 140 #define AP_RESET_IN_PROGRESS 3 /* AP reset in progress */ 141 142 /* 143 * AP interrupt states 144 */ 145 #define AP_INTR_DISABLED 0 /* AP interrupt disabled */ 146 #define AP_INTR_ENABLED 1 /* AP interrupt enabled */ 147 #define AP_INTR_IN_PROGRESS 3 /* AP interrupt in progress */ 148 149 struct ap_device; 150 struct ap_message; 151 152 struct ap_driver { 153 struct device_driver driver; 154 struct ap_device_id *ids; 155 156 int (*probe)(struct ap_device *); 157 void (*remove)(struct ap_device *); 158 int request_timeout; /* request timeout in jiffies */ 159 }; 160 161 #define to_ap_drv(x) container_of((x), struct ap_driver, driver) 162 163 int ap_driver_register(struct ap_driver *, struct module *, char *); 164 void ap_driver_unregister(struct ap_driver *); 165 166 struct ap_device { 167 struct device device; 168 struct ap_driver *drv; /* Pointer to AP device driver. */ 169 spinlock_t lock; /* Per device lock. */ 170 struct list_head list; /* private list of all AP devices. */ 171 172 ap_qid_t qid; /* AP queue id. */ 173 int queue_depth; /* AP queue depth.*/ 174 int device_type; /* AP device type. */ 175 int raw_hwtype; /* AP raw hardware type. */ 176 unsigned int functions; /* AP device function bitfield. */ 177 int unregistered; /* marks AP device as unregistered */ 178 struct timer_list timeout; /* Timer for request timeouts. */ 179 int reset; /* Reset required after req. timeout. */ 180 181 int interrupt; /* indicate if interrupts are enabled */ 182 int queue_count; /* # messages currently on AP queue. */ 183 184 struct list_head pendingq; /* List of message sent to AP queue. */ 185 int pendingq_count; /* # requests on pendingq list. */ 186 struct list_head requestq; /* List of message yet to be sent. */ 187 int requestq_count; /* # requests on requestq list. */ 188 int total_request_count; /* # requests ever for this AP device. */ 189 190 struct ap_message *reply; /* Per device reply message. */ 191 192 void *private; /* ap driver private pointer. */ 193 }; 194 195 #define to_ap_dev(x) container_of((x), struct ap_device, device) 196 197 struct ap_message { 198 struct list_head list; /* Request queueing. */ 199 unsigned long long psmid; /* Message id. */ 200 void *message; /* Pointer to message buffer. */ 201 size_t length; /* Message length. */ 202 203 void *private; /* ap driver private pointer. */ 204 unsigned int special:1; /* Used for special commands. */ 205 /* receive is called from tasklet context */ 206 void (*receive)(struct ap_device *, struct ap_message *, 207 struct ap_message *); 208 }; 209 210 struct ap_config_info { 211 unsigned int special_command:1; 212 unsigned int ap_extended:1; 213 unsigned char reserved1:6; 214 unsigned char reserved2[15]; 215 unsigned int apm[8]; /* AP ID mask */ 216 unsigned int aqm[8]; /* AP queue mask */ 217 unsigned int adm[8]; /* AP domain mask */ 218 unsigned char reserved4[16]; 219 } __packed; 220 221 #define AP_DEVICE(dt) \ 222 .dev_type=(dt), \ 223 .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE, 224 225 /** 226 * ap_init_message() - Initialize ap_message. 227 * Initialize a message before using. Otherwise this might result in 228 * unexpected behaviour. 229 */ 230 static inline void ap_init_message(struct ap_message *ap_msg) 231 { 232 ap_msg->psmid = 0; 233 ap_msg->length = 0; 234 ap_msg->special = 0; 235 ap_msg->receive = NULL; 236 } 237 238 /* 239 * Note: don't use ap_send/ap_recv after using ap_queue_message 240 * for the first time. Otherwise the ap message queue will get 241 * confused. 242 */ 243 int ap_send(ap_qid_t, unsigned long long, void *, size_t); 244 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 245 246 void ap_queue_message(struct ap_device *ap_dev, struct ap_message *ap_msg); 247 void ap_cancel_message(struct ap_device *ap_dev, struct ap_message *ap_msg); 248 void ap_flush_queue(struct ap_device *ap_dev); 249 void ap_bus_force_rescan(void); 250 251 int ap_module_init(void); 252 void ap_module_exit(void); 253 254 #endif /* _AP_BUS_H_ */ 255