2 * RapidIO driver services
4 * Copyright 2005 MontaVista Software, Inc.
5 * Matt Porter <mporter@kernel.crashing.org>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version.
13 #ifndef LINUX_RIO_DRV_H
14 #define LINUX_RIO_DRV_H
16 #include <linux/types.h>
17 #include <linux/ioport.h>
18 #include <linux/list.h>
19 #include <linux/errno.h>
20 #include <linux/device.h>
21 #include <linux/string.h>
22 #include <linux/rio.h>
24 extern int __rio_local_read_config_32(struct rio_mport
*port
, u32 offset
,
26 extern int __rio_local_write_config_32(struct rio_mport
*port
, u32 offset
,
28 extern int __rio_local_read_config_16(struct rio_mport
*port
, u32 offset
,
30 extern int __rio_local_write_config_16(struct rio_mport
*port
, u32 offset
,
32 extern int __rio_local_read_config_8(struct rio_mport
*port
, u32 offset
,
34 extern int __rio_local_write_config_8(struct rio_mport
*port
, u32 offset
,
37 extern int rio_mport_read_config_32(struct rio_mport
*port
, u16 destid
,
38 u8 hopcount
, u32 offset
, u32
* data
);
39 extern int rio_mport_write_config_32(struct rio_mport
*port
, u16 destid
,
40 u8 hopcount
, u32 offset
, u32 data
);
41 extern int rio_mport_read_config_16(struct rio_mport
*port
, u16 destid
,
42 u8 hopcount
, u32 offset
, u16
* data
);
43 extern int rio_mport_write_config_16(struct rio_mport
*port
, u16 destid
,
44 u8 hopcount
, u32 offset
, u16 data
);
45 extern int rio_mport_read_config_8(struct rio_mport
*port
, u16 destid
,
46 u8 hopcount
, u32 offset
, u8
* data
);
47 extern int rio_mport_write_config_8(struct rio_mport
*port
, u16 destid
,
48 u8 hopcount
, u32 offset
, u8 data
);
51 * rio_local_read_config_32 - Read 32 bits from local configuration space
53 * @offset: Offset into local configuration space
54 * @data: Pointer to read data into
56 * Reads 32 bits of data from the specified offset within the local
57 * device's configuration space.
59 static inline int rio_local_read_config_32(struct rio_mport
*port
, u32 offset
,
62 return __rio_local_read_config_32(port
, offset
, data
);
66 * rio_local_write_config_32 - Write 32 bits to local configuration space
68 * @offset: Offset into local configuration space
69 * @data: Data to be written
71 * Writes 32 bits of data to the specified offset within the local
72 * device's configuration space.
74 static inline int rio_local_write_config_32(struct rio_mport
*port
, u32 offset
,
77 return __rio_local_write_config_32(port
, offset
, data
);
81 * rio_local_read_config_16 - Read 16 bits from local configuration space
83 * @offset: Offset into local configuration space
84 * @data: Pointer to read data into
86 * Reads 16 bits of data from the specified offset within the local
87 * device's configuration space.
89 static inline int rio_local_read_config_16(struct rio_mport
*port
, u32 offset
,
92 return __rio_local_read_config_16(port
, offset
, data
);
96 * rio_local_write_config_16 - Write 16 bits to local configuration space
98 * @offset: Offset into local configuration space
99 * @data: Data to be written
101 * Writes 16 bits of data to the specified offset within the local
102 * device's configuration space.
105 static inline int rio_local_write_config_16(struct rio_mport
*port
, u32 offset
,
108 return __rio_local_write_config_16(port
, offset
, data
);
112 * rio_local_read_config_8 - Read 8 bits from local configuration space
114 * @offset: Offset into local configuration space
115 * @data: Pointer to read data into
117 * Reads 8 bits of data from the specified offset within the local
118 * device's configuration space.
120 static inline int rio_local_read_config_8(struct rio_mport
*port
, u32 offset
,
123 return __rio_local_read_config_8(port
, offset
, data
);
127 * rio_local_write_config_8 - Write 8 bits to local configuration space
129 * @offset: Offset into local configuration space
130 * @data: Data to be written
132 * Writes 8 bits of data to the specified offset within the local
133 * device's configuration space.
135 static inline int rio_local_write_config_8(struct rio_mport
*port
, u32 offset
,
138 return __rio_local_write_config_8(port
, offset
, data
);
142 * rio_read_config_32 - Read 32 bits from configuration space
144 * @offset: Offset into device configuration space
145 * @data: Pointer to read data into
147 * Reads 32 bits of data from the specified offset within the
148 * RIO device's configuration space.
150 static inline int rio_read_config_32(struct rio_dev
*rdev
, u32 offset
,
154 u16 destid
= rdev
->destid
;
157 destid
= rdev
->rswitch
->destid
;
158 hopcount
= rdev
->rswitch
->hopcount
;
161 return rio_mport_read_config_32(rdev
->net
->hport
, destid
, hopcount
,
166 * rio_write_config_32 - Write 32 bits to configuration space
168 * @offset: Offset into device configuration space
169 * @data: Data to be written
171 * Writes 32 bits of data to the specified offset within the
172 * RIO device's configuration space.
174 static inline int rio_write_config_32(struct rio_dev
*rdev
, u32 offset
,
178 u16 destid
= rdev
->destid
;
181 destid
= rdev
->rswitch
->destid
;
182 hopcount
= rdev
->rswitch
->hopcount
;
185 return rio_mport_write_config_32(rdev
->net
->hport
, destid
, hopcount
,
190 * rio_read_config_16 - Read 16 bits from configuration space
192 * @offset: Offset into device configuration space
193 * @data: Pointer to read data into
195 * Reads 16 bits of data from the specified offset within the
196 * RIO device's configuration space.
198 static inline int rio_read_config_16(struct rio_dev
*rdev
, u32 offset
,
202 u16 destid
= rdev
->destid
;
205 destid
= rdev
->rswitch
->destid
;
206 hopcount
= rdev
->rswitch
->hopcount
;
209 return rio_mport_read_config_16(rdev
->net
->hport
, destid
, hopcount
,
214 * rio_write_config_16 - Write 16 bits to configuration space
216 * @offset: Offset into device configuration space
217 * @data: Data to be written
219 * Writes 16 bits of data to the specified offset within the
220 * RIO device's configuration space.
222 static inline int rio_write_config_16(struct rio_dev
*rdev
, u32 offset
,
226 u16 destid
= rdev
->destid
;
229 destid
= rdev
->rswitch
->destid
;
230 hopcount
= rdev
->rswitch
->hopcount
;
233 return rio_mport_write_config_16(rdev
->net
->hport
, destid
, hopcount
,
238 * rio_read_config_8 - Read 8 bits from configuration space
240 * @offset: Offset into device configuration space
241 * @data: Pointer to read data into
243 * Reads 8 bits of data from the specified offset within the
244 * RIO device's configuration space.
246 static inline int rio_read_config_8(struct rio_dev
*rdev
, u32 offset
, u8
* data
)
249 u16 destid
= rdev
->destid
;
252 destid
= rdev
->rswitch
->destid
;
253 hopcount
= rdev
->rswitch
->hopcount
;
256 return rio_mport_read_config_8(rdev
->net
->hport
, destid
, hopcount
,
261 * rio_write_config_8 - Write 8 bits to configuration space
263 * @offset: Offset into device configuration space
264 * @data: Data to be written
266 * Writes 8 bits of data to the specified offset within the
267 * RIO device's configuration space.
269 static inline int rio_write_config_8(struct rio_dev
*rdev
, u32 offset
, u8 data
)
272 u16 destid
= rdev
->destid
;
275 destid
= rdev
->rswitch
->destid
;
276 hopcount
= rdev
->rswitch
->hopcount
;
279 return rio_mport_write_config_8(rdev
->net
->hport
, destid
, hopcount
,
283 extern int rio_mport_send_doorbell(struct rio_mport
*mport
, u16 destid
,
287 * rio_send_doorbell - Send a doorbell message to a device
289 * @data: Doorbell message data
291 * Send a doorbell message to a RIO device. The doorbell message
292 * has a 16-bit info field provided by the @data argument.
294 static inline int rio_send_doorbell(struct rio_dev
*rdev
, u16 data
)
296 return rio_mport_send_doorbell(rdev
->net
->hport
, rdev
->destid
, data
);
300 * rio_init_mbox_res - Initialize a RIO mailbox resource
301 * @res: resource struct
302 * @start: start of mailbox range
303 * @end: end of mailbox range
305 * This function is used to initialize the fields of a resource
306 * for use as a mailbox resource. It initializes a range of
307 * mailboxes using the start and end arguments.
309 static inline void rio_init_mbox_res(struct resource
*res
, int start
, int end
)
311 memset(res
, 0, sizeof(struct resource
));
314 res
->flags
= RIO_RESOURCE_MAILBOX
;
318 * rio_init_dbell_res - Initialize a RIO doorbell resource
319 * @res: resource struct
320 * @start: start of doorbell range
321 * @end: end of doorbell range
323 * This function is used to initialize the fields of a resource
324 * for use as a doorbell resource. It initializes a range of
325 * doorbell messages using the start and end arguments.
327 static inline void rio_init_dbell_res(struct resource
*res
, u16 start
, u16 end
)
329 memset(res
, 0, sizeof(struct resource
));
332 res
->flags
= RIO_RESOURCE_DOORBELL
;
336 * RIO_DEVICE - macro used to describe a specific RIO device
337 * @dev: the 16 bit RIO device ID
338 * @ven: the 16 bit RIO vendor ID
340 * This macro is used to create a struct rio_device_id that matches a
341 * specific device. The assembly vendor and assembly device fields
342 * will be set to %RIO_ANY_ID.
344 #define RIO_DEVICE(dev,ven) \
345 .did = (dev), .vid = (ven), \
346 .asm_did = RIO_ANY_ID, .asm_vid = RIO_ANY_ID
348 /* Mailbox management */
349 extern int rio_request_outb_mbox(struct rio_mport
*, void *, int, int,
350 void (*)(struct rio_mport
*, void *,int, int));
351 extern int rio_release_outb_mbox(struct rio_mport
*, int);
354 * rio_add_outb_message - Add RIO message to an outbound mailbox queue
355 * @mport: RIO master port containing the outbound queue
356 * @rdev: RIO device the message is be sent to
357 * @mbox: The outbound mailbox queue
358 * @buffer: Pointer to the message buffer
359 * @len: Length of the message buffer
361 * Adds a RIO message buffer to an outbound mailbox queue for
362 * transmission. Returns 0 on success.
364 static inline int rio_add_outb_message(struct rio_mport
*mport
,
365 struct rio_dev
*rdev
, int mbox
,
366 void *buffer
, size_t len
)
368 return rio_hw_add_outb_message(mport
, rdev
, mbox
, buffer
, len
);
371 extern int rio_request_inb_mbox(struct rio_mport
*, void *, int, int,
372 void (*)(struct rio_mport
*, void *, int, int));
373 extern int rio_release_inb_mbox(struct rio_mport
*, int);
376 * rio_add_inb_buffer - Add buffer to an inbound mailbox queue
377 * @mport: Master port containing the inbound mailbox
378 * @mbox: The inbound mailbox number
379 * @buffer: Pointer to the message buffer
381 * Adds a buffer to an inbound mailbox queue for reception. Returns
384 static inline int rio_add_inb_buffer(struct rio_mport
*mport
, int mbox
,
387 return rio_hw_add_inb_buffer(mport
, mbox
, buffer
);
391 * rio_get_inb_message - Get A RIO message from an inbound mailbox queue
392 * @mport: Master port containing the inbound mailbox
393 * @mbox: The inbound mailbox number
395 * Get a RIO message from an inbound mailbox queue. Returns 0 on success.
397 static inline void *rio_get_inb_message(struct rio_mport
*mport
, int mbox
)
399 return rio_hw_get_inb_message(mport
, mbox
);
402 /* Doorbell management */
403 extern int rio_request_inb_dbell(struct rio_mport
*, void *, u16
, u16
,
404 void (*)(struct rio_mport
*, void *, u16
, u16
, u16
));
405 extern int rio_release_inb_dbell(struct rio_mport
*, u16
, u16
);
406 extern struct resource
*rio_request_outb_dbell(struct rio_dev
*, u16
, u16
);
407 extern int rio_release_outb_dbell(struct rio_dev
*, struct resource
*);
409 /* Memory region management */
410 int rio_claim_resource(struct rio_dev
*, int);
411 int rio_request_regions(struct rio_dev
*, char *);
412 void rio_release_regions(struct rio_dev
*);
413 int rio_request_region(struct rio_dev
*, int, char *);
414 void rio_release_region(struct rio_dev
*, int);
417 int rio_register_driver(struct rio_driver
*);
418 void rio_unregister_driver(struct rio_driver
*);
419 struct rio_dev
*rio_dev_get(struct rio_dev
*);
420 void rio_dev_put(struct rio_dev
*);
423 * rio_name - Get the unique RIO device identifier
426 * Get the unique RIO device identifier. Returns the device
429 static inline const char *rio_name(struct rio_dev
*rdev
)
431 return dev_name(&rdev
->dev
);
435 * rio_get_drvdata - Get RIO driver specific data
438 * Get RIO driver specific data. Returns a pointer to the
439 * driver specific data.
441 static inline void *rio_get_drvdata(struct rio_dev
*rdev
)
443 return dev_get_drvdata(&rdev
->dev
);
447 * rio_set_drvdata - Set RIO driver specific data
449 * @data: Pointer to driver specific data
451 * Set RIO driver specific data. device struct driver data pointer
452 * is set to the @data argument.
454 static inline void rio_set_drvdata(struct rio_dev
*rdev
, void *data
)
456 dev_set_drvdata(&rdev
->dev
, data
);
459 /* Misc driver helpers */
460 extern u16
rio_local_get_device_id(struct rio_mport
*port
);
461 extern struct rio_dev
*rio_get_device(u16 vid
, u16 did
, struct rio_dev
*from
);
462 extern struct rio_dev
*rio_get_asm(u16 vid
, u16 did
, u16 asm_vid
, u16 asm_did
,
463 struct rio_dev
*from
);
465 #endif /* LINUX_RIO_DRV_H */
This page took 0.038989 seconds and 5 git commands to generate.