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