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/types.h> 31 #include <asm/ap.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 extern int ap_domain_index; 40 41 extern spinlock_t ap_list_lock; 42 extern struct list_head ap_card_list; 43 44 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr) 45 { 46 return (*ptr & (0x80000000u >> nr)) != 0; 47 } 48 49 #define AP_RESPONSE_NORMAL 0x00 50 #define AP_RESPONSE_Q_NOT_AVAIL 0x01 51 #define AP_RESPONSE_RESET_IN_PROGRESS 0x02 52 #define AP_RESPONSE_DECONFIGURED 0x03 53 #define AP_RESPONSE_CHECKSTOPPED 0x04 54 #define AP_RESPONSE_BUSY 0x05 55 #define AP_RESPONSE_INVALID_ADDRESS 0x06 56 #define AP_RESPONSE_OTHERWISE_CHANGED 0x07 57 #define AP_RESPONSE_Q_FULL 0x10 58 #define AP_RESPONSE_NO_PENDING_REPLY 0x10 59 #define AP_RESPONSE_INDEX_TOO_BIG 0x11 60 #define AP_RESPONSE_NO_FIRST_PART 0x13 61 #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 62 #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16 63 64 /* 65 * Known device types 66 */ 67 #define AP_DEVICE_TYPE_PCICC 3 68 #define AP_DEVICE_TYPE_PCICA 4 69 #define AP_DEVICE_TYPE_PCIXCC 5 70 #define AP_DEVICE_TYPE_CEX2A 6 71 #define AP_DEVICE_TYPE_CEX2C 7 72 #define AP_DEVICE_TYPE_CEX3A 8 73 #define AP_DEVICE_TYPE_CEX3C 9 74 #define AP_DEVICE_TYPE_CEX4 10 75 #define AP_DEVICE_TYPE_CEX5 11 76 #define AP_DEVICE_TYPE_CEX6 12 77 78 /* 79 * Known function facilities 80 */ 81 #define AP_FUNC_MEX4K 1 82 #define AP_FUNC_CRT4K 2 83 #define AP_FUNC_COPRO 3 84 #define AP_FUNC_ACCEL 4 85 #define AP_FUNC_EP11 5 86 #define AP_FUNC_APXA 6 87 88 /* 89 * AP interrupt states 90 */ 91 #define AP_INTR_DISABLED 0 /* AP interrupt disabled */ 92 #define AP_INTR_ENABLED 1 /* AP interrupt enabled */ 93 94 /* 95 * AP device states 96 */ 97 enum ap_state { 98 AP_STATE_RESET_START, 99 AP_STATE_RESET_WAIT, 100 AP_STATE_SETIRQ_WAIT, 101 AP_STATE_IDLE, 102 AP_STATE_WORKING, 103 AP_STATE_QUEUE_FULL, 104 AP_STATE_SUSPEND_WAIT, 105 AP_STATE_BORKED, 106 NR_AP_STATES 107 }; 108 109 /* 110 * AP device events 111 */ 112 enum ap_event { 113 AP_EVENT_POLL, 114 AP_EVENT_TIMEOUT, 115 NR_AP_EVENTS 116 }; 117 118 /* 119 * AP wait behaviour 120 */ 121 enum ap_wait { 122 AP_WAIT_AGAIN, /* retry immediately */ 123 AP_WAIT_TIMEOUT, /* wait for timeout */ 124 AP_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */ 125 AP_WAIT_NONE, /* no wait */ 126 NR_AP_WAIT 127 }; 128 129 struct ap_device; 130 struct ap_message; 131 132 struct ap_driver { 133 struct device_driver driver; 134 struct ap_device_id *ids; 135 136 int (*probe)(struct ap_device *); 137 void (*remove)(struct ap_device *); 138 void (*suspend)(struct ap_device *); 139 void (*resume)(struct ap_device *); 140 }; 141 142 #define to_ap_drv(x) container_of((x), struct ap_driver, driver) 143 144 int ap_driver_register(struct ap_driver *, struct module *, char *); 145 void ap_driver_unregister(struct ap_driver *); 146 147 struct ap_device { 148 struct device device; 149 struct ap_driver *drv; /* Pointer to AP device driver. */ 150 int device_type; /* AP device type. */ 151 }; 152 153 #define to_ap_dev(x) container_of((x), struct ap_device, device) 154 155 struct ap_card { 156 struct ap_device ap_dev; 157 struct list_head list; /* Private list of AP cards. */ 158 struct list_head queues; /* List of assoc. AP queues */ 159 void *private; /* ap driver private pointer. */ 160 int raw_hwtype; /* AP raw hardware type. */ 161 unsigned int functions; /* AP device function bitfield. */ 162 int queue_depth; /* AP queue depth.*/ 163 int id; /* AP card number. */ 164 atomic_t total_request_count; /* # requests ever for this AP device.*/ 165 }; 166 167 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device) 168 169 struct ap_queue { 170 struct ap_device ap_dev; 171 struct list_head list; /* Private list of AP queues. */ 172 struct ap_card *card; /* Ptr to assoc. AP card. */ 173 spinlock_t lock; /* Per device lock. */ 174 void *private; /* ap driver private pointer. */ 175 ap_qid_t qid; /* AP queue id. */ 176 int interrupt; /* indicate if interrupts are enabled */ 177 int queue_count; /* # messages currently on AP queue. */ 178 enum ap_state state; /* State of the AP device. */ 179 int pendingq_count; /* # requests on pendingq list. */ 180 int requestq_count; /* # requests on requestq list. */ 181 int total_request_count; /* # requests ever for this AP device.*/ 182 int request_timeout; /* Request timout in jiffies. */ 183 struct timer_list timeout; /* Timer for request timeouts. */ 184 struct list_head pendingq; /* List of message sent to AP queue. */ 185 struct list_head requestq; /* List of message yet to be sent. */ 186 struct ap_message *reply; /* Per device reply message. */ 187 }; 188 189 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device) 190 191 typedef enum ap_wait (ap_func_t)(struct ap_queue *queue); 192 193 struct ap_message { 194 struct list_head list; /* Request queueing. */ 195 unsigned long long psmid; /* Message id. */ 196 void *message; /* Pointer to message buffer. */ 197 size_t length; /* Message length. */ 198 int rc; /* Return code for this message */ 199 200 void *private; /* ap driver private pointer. */ 201 unsigned int special:1; /* Used for special commands. */ 202 /* receive is called from tasklet context */ 203 void (*receive)(struct ap_queue *, struct ap_message *, 204 struct ap_message *); 205 }; 206 207 /** 208 * ap_init_message() - Initialize ap_message. 209 * Initialize a message before using. Otherwise this might result in 210 * unexpected behaviour. 211 */ 212 static inline void ap_init_message(struct ap_message *ap_msg) 213 { 214 ap_msg->psmid = 0; 215 ap_msg->length = 0; 216 ap_msg->rc = 0; 217 ap_msg->special = 0; 218 ap_msg->receive = NULL; 219 } 220 221 #define for_each_ap_card(_ac) \ 222 list_for_each_entry(_ac, &ap_card_list, list) 223 224 #define for_each_ap_queue(_aq, _ac) \ 225 list_for_each_entry(_aq, &(_ac)->queues, list) 226 227 /* 228 * Note: don't use ap_send/ap_recv after using ap_queue_message 229 * for the first time. Otherwise the ap message queue will get 230 * confused. 231 */ 232 int ap_send(ap_qid_t, unsigned long long, void *, size_t); 233 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 234 235 enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event); 236 enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event); 237 238 void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg); 239 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg); 240 void ap_flush_queue(struct ap_queue *aq); 241 242 void *ap_airq_ptr(void); 243 void ap_wait(enum ap_wait wait); 244 void ap_request_timeout(struct timer_list *t); 245 void ap_bus_force_rescan(void); 246 247 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg); 248 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type); 249 void ap_queue_remove(struct ap_queue *aq); 250 void ap_queue_suspend(struct ap_device *ap_dev); 251 void ap_queue_resume(struct ap_device *ap_dev); 252 253 struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type, 254 int comp_device_type, unsigned int functions); 255 256 int ap_module_init(void); 257 void ap_module_exit(void); 258 259 #endif /* _AP_BUS_H_ */ 260