ap_bus.h 9.0 KB
Newer Older
1
/*
2
 * Copyright IBM Corp. 2006, 2012
3 4 5
 * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
 *	      Martin Schwidefsky <schwidefsky@de.ibm.com>
 *	      Ralph Wuerthner <rwuerthn@de.ibm.com>
F
Felix Beck 已提交
6
 *	      Felix Beck <felix.beck@de.ibm.com>
7
 *	      Holger Dengler <hd@linux.vnet.ibm.com>
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
 *
 * Adjunct processor bus header file.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef _AP_BUS_H_
#define _AP_BUS_H_

#include <linux/device.h>
#include <linux/types.h>

#define AP_DEVICES 64		/* Number of AP devices. */
33
#define AP_DOMAINS 256		/* Number of AP domains. */
34
#define AP_RESET_TIMEOUT (HZ*0.7)	/* Time in ticks for reset timeouts. */
35 36 37 38 39
#define AP_CONFIG_TIME 30	/* Time in seconds between AP bus rescans. */
#define AP_POLL_TIME 1		/* Time in ticks between receive polls. */

extern int ap_domain_index;

40 41 42
extern spinlock_t ap_list_lock;
extern struct list_head ap_card_list;

43 44
/**
 * The ap_qid_t identifier of an ap queue. It contains a
45
 * 6 bit card index and a 4 bit queue index (domain).
46 47 48
 */
typedef unsigned int ap_qid_t;

49 50
#define AP_MKQID(_card, _queue) (((_card) & 63) << 8 | ((_queue) & 255))
#define AP_QID_CARD(_qid) (((_qid) >> 8) & 63)
51
#define AP_QID_QUEUE(_qid) ((_qid) & 255)
52 53

/**
54 55 56 57 58 59
 * structy ap_queue_status - Holds the AP queue status.
 * @queue_empty: Shows if queue is empty
 * @replies_waiting: Waiting replies
 * @queue_full: Is 1 if the queue is full
 * @pad: A 4 bit pad
 * @int_enabled: Shows if interrupts are enabled for the AP
60
 * @response_code: Holds the 8 bit response code
61 62
 * @pad2: A 16 bit pad
 *
63 64 65 66 67 68 69 70
 * The ap queue status word is returned by all three AP functions
 * (PQAP, NQAP and DQAP).  There's a set of flags in the first
 * byte, followed by a 1 byte response code.
 */
struct ap_queue_status {
	unsigned int queue_empty	: 1;
	unsigned int replies_waiting	: 1;
	unsigned int queue_full		: 1;
F
Felix Beck 已提交
71 72
	unsigned int pad1		: 4;
	unsigned int int_enabled	: 1;
73 74
	unsigned int response_code	: 8;
	unsigned int pad2		: 16;
75 76 77
} __packed;


78
static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
79
{
80
	return (*ptr & (0x80000000u >> nr)) != 0;
81
}
82 83 84 85 86 87 88

#define AP_RESPONSE_NORMAL		0x00
#define AP_RESPONSE_Q_NOT_AVAIL		0x01
#define AP_RESPONSE_RESET_IN_PROGRESS	0x02
#define AP_RESPONSE_DECONFIGURED	0x03
#define AP_RESPONSE_CHECKSTOPPED	0x04
#define AP_RESPONSE_BUSY		0x05
F
Felix Beck 已提交
89 90
#define AP_RESPONSE_INVALID_ADDRESS	0x06
#define AP_RESPONSE_OTHERWISE_CHANGED	0x07
91 92 93 94 95
#define AP_RESPONSE_Q_FULL		0x10
#define AP_RESPONSE_NO_PENDING_REPLY	0x10
#define AP_RESPONSE_INDEX_TOO_BIG	0x11
#define AP_RESPONSE_NO_FIRST_PART	0x13
#define AP_RESPONSE_MESSAGE_TOO_BIG	0x15
96
#define AP_RESPONSE_REQ_FAC_NOT_INST	0x16
97

98
/*
99 100 101 102 103 104 105
 * Known device types
 */
#define AP_DEVICE_TYPE_PCICC	3
#define AP_DEVICE_TYPE_PCICA	4
#define AP_DEVICE_TYPE_PCIXCC	5
#define AP_DEVICE_TYPE_CEX2A	6
#define AP_DEVICE_TYPE_CEX2C	7
106 107
#define AP_DEVICE_TYPE_CEX3A	8
#define AP_DEVICE_TYPE_CEX3C	9
108
#define AP_DEVICE_TYPE_CEX4	10
109
#define AP_DEVICE_TYPE_CEX5	11
110
#define AP_DEVICE_TYPE_CEX6	12
111

112 113 114 115 116 117 118
/*
 * Known function facilities
 */
#define AP_FUNC_MEX4K 1
#define AP_FUNC_CRT4K 2
#define AP_FUNC_COPRO 3
#define AP_FUNC_ACCEL 4
119 120
#define AP_FUNC_EP11  5
#define AP_FUNC_APXA  6
121

122 123 124 125 126
/*
 * AP interrupt states
 */
#define AP_INTR_DISABLED	0	/* AP interrupt disabled */
#define AP_INTR_ENABLED		1	/* AP interrupt enabled */
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161

/*
 * AP device states
 */
enum ap_state {
	AP_STATE_RESET_START,
	AP_STATE_RESET_WAIT,
	AP_STATE_SETIRQ_WAIT,
	AP_STATE_IDLE,
	AP_STATE_WORKING,
	AP_STATE_QUEUE_FULL,
	AP_STATE_SUSPEND_WAIT,
	AP_STATE_BORKED,
	NR_AP_STATES
};

/*
 * AP device events
 */
enum ap_event {
	AP_EVENT_POLL,
	AP_EVENT_TIMEOUT,
	NR_AP_EVENTS
};

/*
 * AP wait behaviour
 */
enum ap_wait {
	AP_WAIT_AGAIN,		/* retry immediately */
	AP_WAIT_TIMEOUT,	/* wait for timeout */
	AP_WAIT_INTERRUPT,	/* wait for thin interrupt (if available) */
	AP_WAIT_NONE,		/* no wait */
	NR_AP_WAIT
};
162

163 164 165 166 167 168 169 170 171
struct ap_device;
struct ap_message;

struct ap_driver {
	struct device_driver driver;
	struct ap_device_id *ids;

	int (*probe)(struct ap_device *);
	void (*remove)(struct ap_device *);
172 173
	void (*suspend)(struct ap_device *);
	void (*resume)(struct ap_device *);
174 175 176 177 178 179 180 181 182 183
};

#define to_ap_drv(x) container_of((x), struct ap_driver, driver)

int ap_driver_register(struct ap_driver *, struct module *, char *);
void ap_driver_unregister(struct ap_driver *);

struct ap_device {
	struct device device;
	struct ap_driver *drv;		/* Pointer to AP device driver. */
184 185
	int device_type;		/* AP device type. */
};
186

187
#define to_ap_dev(x) container_of((x), struct ap_device, device)
188

189 190 191 192 193
struct ap_card {
	struct ap_device ap_dev;
	struct list_head list;		/* Private list of AP cards. */
	struct list_head queues;	/* List of assoc. AP queues */
	void *private;			/* ap driver private pointer. */
194
	int raw_hwtype;			/* AP raw hardware type. */
195
	unsigned int functions;		/* AP device function bitfield. */
196 197
	int queue_depth;		/* AP queue depth.*/
	int id;				/* AP card number. */
198
	atomic_t total_request_count;	/* # requests ever for this AP device.*/
199 200 201
};

#define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
202

203 204 205 206 207 208 209
struct ap_queue {
	struct ap_device ap_dev;
	struct list_head list;		/* Private list of AP queues. */
	struct ap_card *card;		/* Ptr to assoc. AP card. */
	spinlock_t lock;		/* Per device lock. */
	void *private;			/* ap driver private pointer. */
	ap_qid_t qid;			/* AP queue id. */
210
	int interrupt;			/* indicate if interrupts are enabled */
211
	int queue_count;		/* # messages currently on AP queue. */
212
	enum ap_state state;		/* State of the AP device. */
213 214
	int pendingq_count;		/* # requests on pendingq list. */
	int requestq_count;		/* # requests on requestq list. */
215
	int total_request_count;	/* # requests ever for this AP device.*/
216 217 218 219
	int request_timeout;		/* Request timout in jiffies. */
	struct timer_list timeout;	/* Timer for request timeouts. */
	struct list_head pendingq;	/* List of message sent to AP queue. */
	struct list_head requestq;	/* List of message yet to be sent. */
220 221 222
	struct ap_message *reply;	/* Per device reply message. */
};

223 224 225
#define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)

typedef enum ap_wait (ap_func_t)(struct ap_queue *queue);
226 227 228 229 230 231

struct ap_message {
	struct list_head list;		/* Request queueing. */
	unsigned long long psmid;	/* Message id. */
	void *message;			/* Pointer to message buffer. */
	size_t length;			/* Message length. */
232
	int rc;				/* Return code for this message */
233 234

	void *private;			/* ap driver private pointer. */
235
	unsigned int special:1;		/* Used for special commands. */
236
	/* receive is called from tasklet context */
237
	void (*receive)(struct ap_queue *, struct ap_message *,
238
			struct ap_message *);
239 240
};

241 242 243 244 245 246 247 248 249 250 251
struct ap_config_info {
	unsigned int special_command:1;
	unsigned int ap_extended:1;
	unsigned char reserved1:6;
	unsigned char reserved2[15];
	unsigned int apm[8];		/* AP ID mask */
	unsigned int aqm[8];		/* AP queue mask */
	unsigned int adm[8];		/* AP domain mask */
	unsigned char reserved4[16];
} __packed;

252 253 254 255 256 257 258 259 260
/**
 * ap_init_message() - Initialize ap_message.
 * Initialize a message before using. Otherwise this might result in
 * unexpected behaviour.
 */
static inline void ap_init_message(struct ap_message *ap_msg)
{
	ap_msg->psmid = 0;
	ap_msg->length = 0;
261
	ap_msg->rc = 0;
262
	ap_msg->special = 0;
263
	ap_msg->receive = NULL;
264 265
}

266 267 268 269 270 271
#define for_each_ap_card(_ac) \
	list_for_each_entry(_ac, &ap_card_list, list)

#define for_each_ap_queue(_aq, _ac) \
	list_for_each_entry(_aq, &(_ac)->queues, list)

272
/*
273 274 275 276 277 278 279
 * Note: don't use ap_send/ap_recv after using ap_queue_message
 * for the first time. Otherwise the ap message queue will get
 * confused.
 */
int ap_send(ap_qid_t, unsigned long long, void *, size_t);
int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);

280 281 282 283 284 285 286 287 288 289
enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event);
enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event);

void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
void ap_flush_queue(struct ap_queue *aq);

void *ap_airq_ptr(void);
void ap_wait(enum ap_wait wait);
void ap_request_timeout(unsigned long data);
290
void ap_bus_force_rescan(void);
291 292 293 294 295 296 297 298 299

void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
void ap_queue_remove(struct ap_queue *aq);
void ap_queue_suspend(struct ap_device *ap_dev);
void ap_queue_resume(struct ap_device *ap_dev);

struct ap_card *ap_card_create(int id, int queue_depth, int device_type,
			       unsigned int device_functions);
300 301 302 303 304

int ap_module_init(void);
void ap_module_exit(void);

#endif /* _AP_BUS_H_ */