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_MAX_RESET 90 /* Maximum number of resets. */ 36#define AP_RESET_TIMEOUT (HZ*0.7) /* 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 40extern 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 */ 46typedef unsigned int ap_qid_t; 47 48#define AP_MKQID(_device, _queue) (((_device) & 63) << 8 | ((_queue) & 255)) 49#define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63) 50#define AP_QID_QUEUE(_qid) ((_qid) & 255) 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 */ 66struct 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 : 4; 71 unsigned int int_enabled : 1; 72 unsigned int response_code : 8; 73 unsigned int pad2 : 16; 74} __packed; 75 76#define AP_QUEUE_STATUS_INVALID \ 77 { 1, 1, 1, 0xF, 1, 0xFF, 0xFFFF } 78 79static inline 80int ap_queue_status_invalid_test(struct ap_queue_status *status) 81{ 82 struct ap_queue_status invalid = AP_QUEUE_STATUS_INVALID; 83 return !(memcmp(status, &invalid, sizeof(struct ap_queue_status))); 84} 85 86#define AP_MAX_BITS 31 87static inline int ap_test_bit(unsigned int *ptr, unsigned int nr) 88{ 89 if (nr > AP_MAX_BITS) 90 return 0; 91 return (*ptr & (0x80000000u >> nr)) != 0; 92} 93 94#define AP_RESPONSE_NORMAL 0x00 95#define AP_RESPONSE_Q_NOT_AVAIL 0x01 96#define AP_RESPONSE_RESET_IN_PROGRESS 0x02 97#define AP_RESPONSE_DECONFIGURED 0x03 98#define AP_RESPONSE_CHECKSTOPPED 0x04 99#define AP_RESPONSE_BUSY 0x05 100#define AP_RESPONSE_INVALID_ADDRESS 0x06 101#define AP_RESPONSE_OTHERWISE_CHANGED 0x07 102#define AP_RESPONSE_Q_FULL 0x10 103#define AP_RESPONSE_NO_PENDING_REPLY 0x10 104#define AP_RESPONSE_INDEX_TOO_BIG 0x11 105#define AP_RESPONSE_NO_FIRST_PART 0x13 106#define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 107#define AP_RESPONSE_REQ_FAC_NOT_INST 0x16 108 109/* 110 * Known device types 111 */ 112#define AP_DEVICE_TYPE_PCICC 3 113#define AP_DEVICE_TYPE_PCICA 4 114#define AP_DEVICE_TYPE_PCIXCC 5 115#define AP_DEVICE_TYPE_CEX2A 6 116#define AP_DEVICE_TYPE_CEX2C 7 117#define AP_DEVICE_TYPE_CEX3A 8 118#define AP_DEVICE_TYPE_CEX3C 9 119#define AP_DEVICE_TYPE_CEX4 10 120#define AP_DEVICE_TYPE_CEX5 11 121 122/* 123 * Known function facilities 124 */ 125#define AP_FUNC_MEX4K 1 126#define AP_FUNC_CRT4K 2 127#define AP_FUNC_COPRO 3 128#define AP_FUNC_ACCEL 4 129#define AP_FUNC_EP11 5 130#define AP_FUNC_APXA 6 131 132/* 133 * AP reset flag states 134 */ 135#define AP_RESET_IGNORE 0 /* request timeout will be ignored */ 136#define AP_RESET_ARMED 1 /* request timeout timer is active */ 137#define AP_RESET_DO 2 /* AP reset required */ 138 139struct ap_device; 140struct ap_message; 141 142struct ap_driver { 143 struct device_driver driver; 144 struct ap_device_id *ids; 145 146 int (*probe)(struct ap_device *); 147 void (*remove)(struct ap_device *); 148 int request_timeout; /* request timeout in jiffies */ 149}; 150 151#define to_ap_drv(x) container_of((x), struct ap_driver, driver) 152 153int ap_driver_register(struct ap_driver *, struct module *, char *); 154void ap_driver_unregister(struct ap_driver *); 155 156struct ap_device { 157 struct device device; 158 struct ap_driver *drv; /* Pointer to AP device driver. */ 159 spinlock_t lock; /* Per device lock. */ 160 struct list_head list; /* private list of all AP devices. */ 161 162 ap_qid_t qid; /* AP queue id. */ 163 int queue_depth; /* AP queue depth.*/ 164 int device_type; /* AP device type. */ 165 int raw_hwtype; /* AP raw hardware type. */ 166 unsigned int functions; /* AP device function bitfield. */ 167 int unregistered; /* marks AP device as unregistered */ 168 struct timer_list timeout; /* Timer for request timeouts. */ 169 int reset; /* Reset required after req. timeout. */ 170 171 int queue_count; /* # messages currently on AP queue. */ 172 173 struct list_head pendingq; /* List of message sent to AP queue. */ 174 int pendingq_count; /* # requests on pendingq list. */ 175 struct list_head requestq; /* List of message yet to be sent. */ 176 int requestq_count; /* # requests on requestq list. */ 177 int total_request_count; /* # requests ever for this AP device. */ 178 179 struct ap_message *reply; /* Per device reply message. */ 180 181 void *private; /* ap driver private pointer. */ 182}; 183 184#define to_ap_dev(x) container_of((x), struct ap_device, device) 185 186struct ap_message { 187 struct list_head list; /* Request queueing. */ 188 unsigned long long psmid; /* Message id. */ 189 void *message; /* Pointer to message buffer. */ 190 size_t length; /* Message length. */ 191 192 void *private; /* ap driver private pointer. */ 193 unsigned int special:1; /* Used for special commands. */ 194 /* receive is called from tasklet context */ 195 void (*receive)(struct ap_device *, struct ap_message *, 196 struct ap_message *); 197}; 198 199struct ap_config_info { 200 unsigned int special_command:1; 201 unsigned int ap_extended:1; 202 unsigned char reserved1:6; 203 unsigned char reserved2[15]; 204 unsigned int apm[8]; /* AP ID mask */ 205 unsigned int aqm[8]; /* AP queue mask */ 206 unsigned int adm[8]; /* AP domain mask */ 207 unsigned char reserved4[16]; 208} __packed; 209 210#define AP_DEVICE(dt) \ 211 .dev_type=(dt), \ 212 .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE, 213 214/** 215 * ap_init_message() - Initialize ap_message. 216 * Initialize a message before using. Otherwise this might result in 217 * unexpected behaviour. 218 */ 219static inline void ap_init_message(struct ap_message *ap_msg) 220{ 221 ap_msg->psmid = 0; 222 ap_msg->length = 0; 223 ap_msg->special = 0; 224 ap_msg->receive = NULL; 225} 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 */ 232int ap_send(ap_qid_t, unsigned long long, void *, size_t); 233int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 234 235void ap_queue_message(struct ap_device *ap_dev, struct ap_message *ap_msg); 236void ap_cancel_message(struct ap_device *ap_dev, struct ap_message *ap_msg); 237void ap_flush_queue(struct ap_device *ap_dev); 238void ap_bus_force_rescan(void); 239 240int ap_module_init(void); 241void ap_module_exit(void); 242 243#endif /* _AP_BUS_H_ */ 244