2 * RapidIO interconnect services
3 * (RapidIO Interconnect Specification, http://www.rapidio.org)
5 * Copyright 2005 MontaVista Software, Inc.
6 * Matt Porter <mporter@kernel.crashing.org>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
14 #include <linux/config.h>
15 #include <linux/types.h>
16 #include <linux/kernel.h>
18 #include <linux/delay.h>
19 #include <linux/init.h>
20 #include <linux/rio.h>
21 #include <linux/rio_drv.h>
22 #include <linux/rio_ids.h>
23 #include <linux/rio_regs.h>
24 #include <linux/module.h>
25 #include <linux/spinlock.h>
26 #include <linux/slab.h>
30 static LIST_HEAD(rio_mports);
33 * rio_local_get_device_id - Get the base/extended device id for a port
34 * @port: RIO master port from which to get the deviceid
36 * Reads the base/extended device id from the local device
37 * implementing the master port. Returns the 8/16-bit device
40 u16 rio_local_get_device_id(struct rio_mport *port)
44 rio_local_read_config_32(port, RIO_DID_CSR, &result);
46 return (RIO_GET_DID(result));
50 * rio_request_inb_mbox - request inbound mailbox service
51 * @mport: RIO master port from which to allocate the mailbox resource
52 * @dev_id: Device specific pointer to pass on event
53 * @mbox: Mailbox number to claim
54 * @entries: Number of entries in inbound mailbox queue
55 * @minb: Callback to execute when inbound message is received
57 * Requests ownership of an inbound mailbox resource and binds
58 * a callback function to the resource. Returns %0 on success.
60 int rio_request_inb_mbox(struct rio_mport *mport,
64 void (*minb) (struct rio_mport * mport, void *dev_id, int mbox,
69 struct resource *res = kmalloc(sizeof(struct resource), GFP_KERNEL);
72 rio_init_mbox_res(res, mbox, mbox);
74 /* Make sure this mailbox isn't in use */
76 request_resource(&mport->riores[RIO_INB_MBOX_RESOURCE],
82 mport->inb_msg[mbox].res = res;
84 /* Hook the inbound message callback */
85 mport->inb_msg[mbox].mcback = minb;
87 rc = rio_open_inb_mbox(mport, dev_id, mbox, entries);
96 * rio_release_inb_mbox - release inbound mailbox message service
97 * @mport: RIO master port from which to release the mailbox resource
98 * @mbox: Mailbox number to release
100 * Releases ownership of an inbound mailbox resource. Returns 0
101 * if the request has been satisfied.
103 int rio_release_inb_mbox(struct rio_mport *mport, int mbox)
105 rio_close_inb_mbox(mport, mbox);
107 /* Release the mailbox resource */
108 return release_resource(mport->inb_msg[mbox].res);
112 * rio_request_outb_mbox - request outbound mailbox service
113 * @mport: RIO master port from which to allocate the mailbox resource
114 * @dev_id: Device specific pointer to pass on event
115 * @mbox: Mailbox number to claim
116 * @entries: Number of entries in outbound mailbox queue
117 * @moutb: Callback to execute when outbound message is sent
119 * Requests ownership of an outbound mailbox resource and binds
120 * a callback function to the resource. Returns 0 on success.
122 int rio_request_outb_mbox(struct rio_mport *mport,
126 void (*moutb) (struct rio_mport * mport, void *dev_id, int mbox, int slot))
130 struct resource *res = kmalloc(sizeof(struct resource), GFP_KERNEL);
133 rio_init_mbox_res(res, mbox, mbox);
135 /* Make sure this outbound mailbox isn't in use */
137 request_resource(&mport->riores[RIO_OUTB_MBOX_RESOURCE],
143 mport->outb_msg[mbox].res = res;
145 /* Hook the inbound message callback */
146 mport->outb_msg[mbox].mcback = moutb;
148 rc = rio_open_outb_mbox(mport, dev_id, mbox, entries);
157 * rio_release_outb_mbox - release outbound mailbox message service
158 * @mport: RIO master port from which to release the mailbox resource
159 * @mbox: Mailbox number to release
161 * Releases ownership of an inbound mailbox resource. Returns 0
162 * if the request has been satisfied.
164 int rio_release_outb_mbox(struct rio_mport *mport, int mbox)
166 rio_close_outb_mbox(mport, mbox);
168 /* Release the mailbox resource */
169 return release_resource(mport->outb_msg[mbox].res);
173 * rio_setup_inb_dbell - bind inbound doorbell callback
174 * @mport: RIO master port to bind the doorbell callback
175 * @dev_id: Device specific pointer to pass on event
176 * @res: Doorbell message resource
177 * @dinb: Callback to execute when doorbell is received
179 * Adds a doorbell resource/callback pair into a port's
180 * doorbell event list. Returns 0 if the request has been
184 rio_setup_inb_dbell(struct rio_mport *mport, void *dev_id, struct resource *res,
185 void (*dinb) (struct rio_mport * mport, void *dev_id, u16 src, u16 dst,
189 struct rio_dbell *dbell;
191 if (!(dbell = kmalloc(sizeof(struct rio_dbell), GFP_KERNEL))) {
198 dbell->dev_id = dev_id;
200 list_add_tail(&dbell->node, &mport->dbells);
207 * rio_request_inb_dbell - request inbound doorbell message service
208 * @mport: RIO master port from which to allocate the doorbell resource
209 * @dev_id: Device specific pointer to pass on event
210 * @start: Doorbell info range start
211 * @end: Doorbell info range end
212 * @dinb: Callback to execute when doorbell is received
214 * Requests ownership of an inbound doorbell resource and binds
215 * a callback function to the resource. Returns 0 if the request
216 * has been satisfied.
218 int rio_request_inb_dbell(struct rio_mport *mport,
222 void (*dinb) (struct rio_mport * mport, void *dev_id, u16 src,
227 struct resource *res = kmalloc(sizeof(struct resource), GFP_KERNEL);
230 rio_init_dbell_res(res, start, end);
232 /* Make sure these doorbells aren't in use */
234 request_resource(&mport->riores[RIO_DOORBELL_RESOURCE],
240 /* Hook the doorbell callback */
241 rc = rio_setup_inb_dbell(mport, dev_id, res, dinb);
250 * rio_release_inb_dbell - release inbound doorbell message service
251 * @mport: RIO master port from which to release the doorbell resource
252 * @start: Doorbell info range start
253 * @end: Doorbell info range end
255 * Releases ownership of an inbound doorbell resource and removes
256 * callback from the doorbell event list. Returns 0 if the request
257 * has been satisfied.
259 int rio_release_inb_dbell(struct rio_mport *mport, u16 start, u16 end)
261 int rc = 0, found = 0;
262 struct rio_dbell *dbell;
264 list_for_each_entry(dbell, &mport->dbells, node) {
265 if ((dbell->res->start == start) && (dbell->res->end == end)) {
271 /* If we can't find an exact match, fail */
277 /* Delete from list */
278 list_del(&dbell->node);
280 /* Release the doorbell resource */
281 rc = release_resource(dbell->res);
283 /* Free the doorbell event */
291 * rio_request_outb_dbell - request outbound doorbell message range
292 * @rdev: RIO device from which to allocate the doorbell resource
293 * @start: Doorbell message range start
294 * @end: Doorbell message range end
296 * Requests ownership of a doorbell message range. Returns a resource
297 * if the request has been satisfied or %NULL on failure.
299 struct resource *rio_request_outb_dbell(struct rio_dev *rdev, u16 start,
302 struct resource *res = kmalloc(sizeof(struct resource), GFP_KERNEL);
305 rio_init_dbell_res(res, start, end);
307 /* Make sure these doorbells aren't in use */
308 if (request_resource(&rdev->riores[RIO_DOORBELL_RESOURCE], res)
319 * rio_release_outb_dbell - release outbound doorbell message range
320 * @rdev: RIO device from which to release the doorbell resource
321 * @res: Doorbell resource to be freed
323 * Releases ownership of a doorbell message range. Returns 0 if the
324 * request has been satisfied.
326 int rio_release_outb_dbell(struct rio_dev *rdev, struct resource *res)
328 int rc = release_resource(res);
336 * rio_mport_get_feature - query for devices' extended features
337 * @port: Master port to issue transaction
338 * @local: Indicate a local master port or remote device access
339 * @destid: Destination ID of the device
340 * @hopcount: Number of switch hops to the device
341 * @ftr: Extended feature code
343 * Tell if a device supports a given RapidIO capability.
344 * Returns the offset of the requested extended feature
345 * block within the device's RIO configuration space or
346 * 0 in case the device does not support it. Possible
349 * %RIO_EFB_PAR_EP_ID LP/LVDS EP Devices
351 * %RIO_EFB_PAR_EP_REC_ID LP/LVDS EP Recovery Devices
353 * %RIO_EFB_PAR_EP_FREE_ID LP/LVDS EP Free Devices
355 * %RIO_EFB_SER_EP_ID LP/Serial EP Devices
357 * %RIO_EFB_SER_EP_REC_ID LP/Serial EP Recovery Devices
359 * %RIO_EFB_SER_EP_FREE_ID LP/Serial EP Free Devices
362 rio_mport_get_feature(struct rio_mport * port, int local, u16 destid,
363 u8 hopcount, int ftr)
365 u32 asm_info, ext_ftr_ptr, ftr_header;
368 rio_local_read_config_32(port, RIO_ASM_INFO_CAR, &asm_info);
370 rio_mport_read_config_32(port, destid, hopcount,
371 RIO_ASM_INFO_CAR, &asm_info);
373 ext_ftr_ptr = asm_info & RIO_EXT_FTR_PTR_MASK;
375 while (ext_ftr_ptr) {
377 rio_local_read_config_32(port, ext_ftr_ptr,
380 rio_mport_read_config_32(port, destid, hopcount,
381 ext_ftr_ptr, &ftr_header);
382 if (RIO_GET_BLOCK_ID(ftr_header) == ftr)
384 if (!(ext_ftr_ptr = RIO_GET_BLOCK_PTR(ftr_header)))
392 * rio_get_asm - Begin or continue searching for a RIO device by vid/did/asm_vid/asm_did
393 * @vid: RIO vid to match or %RIO_ANY_ID to match all vids
394 * @did: RIO did to match or %RIO_ANY_ID to match all dids
395 * @asm_vid: RIO asm_vid to match or %RIO_ANY_ID to match all asm_vids
396 * @asm_did: RIO asm_did to match or %RIO_ANY_ID to match all asm_dids
397 * @from: Previous RIO device found in search, or %NULL for new search
399 * Iterates through the list of known RIO devices. If a RIO device is
400 * found with a matching @vid, @did, @asm_vid, @asm_did, the reference
401 * count to the device is incrememted and a pointer to its device
402 * structure is returned. Otherwise, %NULL is returned. A new search
403 * is initiated by passing %NULL to the @from argument. Otherwise, if
404 * @from is not %NULL, searches continue from next device on the global
405 * list. The reference count for @from is always decremented if it is
408 struct rio_dev *rio_get_asm(u16 vid, u16 did,
409 u16 asm_vid, u16 asm_did, struct rio_dev *from)
412 struct rio_dev *rdev;
414 WARN_ON(in_interrupt());
415 spin_lock(&rio_global_list_lock);
416 n = from ? from->global_list.next : rio_devices.next;
418 while (n && (n != &rio_devices)) {
420 if ((vid == RIO_ANY_ID || rdev->vid == vid) &&
421 (did == RIO_ANY_ID || rdev->did == did) &&
422 (asm_vid == RIO_ANY_ID || rdev->asm_vid == asm_vid) &&
423 (asm_did == RIO_ANY_ID || rdev->asm_did == asm_did))
430 rdev = rio_dev_get(rdev);
431 spin_unlock(&rio_global_list_lock);
436 * rio_get_device - Begin or continue searching for a RIO device by vid/did
437 * @vid: RIO vid to match or %RIO_ANY_ID to match all vids
438 * @did: RIO did to match or %RIO_ANY_ID to match all dids
439 * @from: Previous RIO device found in search, or %NULL for new search
441 * Iterates through the list of known RIO devices. If a RIO device is
442 * found with a matching @vid and @did, the reference count to the
443 * device is incrememted and a pointer to its device structure is returned.
444 * Otherwise, %NULL is returned. A new search is initiated by passing %NULL
445 * to the @from argument. Otherwise, if @from is not %NULL, searches
446 * continue from next device on the global list. The reference count for
447 * @from is always decremented if it is not %NULL.
449 struct rio_dev *rio_get_device(u16 vid, u16 did, struct rio_dev *from)
451 return rio_get_asm(vid, did, RIO_ANY_ID, RIO_ANY_ID, from);
454 static void rio_fixup_device(struct rio_dev *dev)
458 static int __devinit rio_init(void)
460 struct rio_dev *dev = NULL;
462 while ((dev = rio_get_device(RIO_ANY_ID, RIO_ANY_ID, dev)) != NULL) {
463 rio_fixup_device(dev);
468 device_initcall(rio_init);
470 int rio_init_mports(void)
473 struct rio_mport *port;
475 list_for_each_entry(port, &rio_mports, node) {
476 if (!request_mem_region(port->iores.start,
477 port->iores.end - port->iores.start,
480 "RIO: Error requesting master port region %8.8lx-%8.8lx\n",
481 port->iores.start, port->iores.end - 1);
486 if (port->host_deviceid >= 0)
487 rio_enum_mport(port);
489 rio_disc_mport(port);
496 void rio_register_mport(struct rio_mport *port)
498 list_add_tail(&port->node, &rio_mports);
501 EXPORT_SYMBOL_GPL(rio_local_get_device_id);
502 EXPORT_SYMBOL_GPL(rio_get_device);
503 EXPORT_SYMBOL_GPL(rio_get_asm);
504 EXPORT_SYMBOL_GPL(rio_request_inb_dbell);
505 EXPORT_SYMBOL_GPL(rio_release_inb_dbell);
506 EXPORT_SYMBOL_GPL(rio_request_outb_dbell);
507 EXPORT_SYMBOL_GPL(rio_release_outb_dbell);
508 EXPORT_SYMBOL_GPL(rio_request_inb_mbox);
509 EXPORT_SYMBOL_GPL(rio_release_inb_mbox);
510 EXPORT_SYMBOL_GPL(rio_request_outb_mbox);
511 EXPORT_SYMBOL_GPL(rio_release_outb_mbox);