0afdf482517e78868a46d88a144bf90a01c0b506
[pandora-kernel.git] / drivers / rapidio / rio.h
1 /*
2  * RapidIO interconnect services
3  *
4  * Copyright 2005 MontaVista Software, Inc.
5  * Matt Porter <mporter@kernel.crashing.org>
6  *
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.
11  */
12
13 #include <linux/device.h>
14 #include <linux/list.h>
15 #include <linux/rio.h>
16
17 #define RIO_MAX_CHK_RETRY       3
18 #define RIO_MPORT_ANY           (-1)
19
20 /* Functions internal to the RIO core code */
21
22 extern u32 rio_mport_get_feature(struct rio_mport *mport, int local, u16 destid,
23                                  u8 hopcount, int ftr);
24 extern u32 rio_mport_get_physefb(struct rio_mport *port, int local,
25                                  u16 destid, u8 hopcount);
26 extern u32 rio_mport_get_efb(struct rio_mport *port, int local, u16 destid,
27                              u8 hopcount, u32 from);
28 extern int rio_mport_chk_dev_access(struct rio_mport *mport, u16 destid,
29                                     u8 hopcount);
30 extern int rio_create_sysfs_dev_files(struct rio_dev *rdev);
31 extern int rio_std_route_add_entry(struct rio_mport *mport, u16 destid,
32                                    u8 hopcount, u16 table, u16 route_destid,
33                                    u8 route_port);
34 extern int rio_std_route_get_entry(struct rio_mport *mport, u16 destid,
35                                    u8 hopcount, u16 table, u16 route_destid,
36                                    u8 *route_port);
37 extern int rio_std_route_clr_table(struct rio_mport *mport, u16 destid,
38                                    u8 hopcount, u16 table);
39 extern int rio_set_port_lockout(struct rio_dev *rdev, u32 pnum, int lock);
40 extern struct rio_dev *rio_get_comptag(u32 comp_tag, struct rio_dev *from);
41 extern int rio_add_device(struct rio_dev *rdev);
42 extern void rio_switch_init(struct rio_dev *rdev, int do_enum);
43 extern int rio_enable_rx_tx_port(struct rio_mport *port, int local, u16 destid,
44                                  u8 hopcount, u8 port_num);
45 extern int rio_register_scan(int mport_id, struct rio_scan *scan_ops);
46 extern int rio_unregister_scan(int mport_id);
47 extern void rio_attach_device(struct rio_dev *rdev);
48
49 /* Structures internal to the RIO core code */
50 extern struct device_attribute rio_dev_attrs[];
51
52 extern struct rio_switch_ops __start_rio_switch_ops[];
53 extern struct rio_switch_ops __end_rio_switch_ops[];
54
55 /* Helpers internal to the RIO core code */
56 #define DECLARE_RIO_SWITCH_SECTION(section, name, vid, did, init_hook) \
57         static const struct rio_switch_ops __rio_switch_##name __used \
58         __section(section) = { vid, did, init_hook };
59
60 /**
61  * DECLARE_RIO_SWITCH_INIT - Registers switch initialization routine
62  * @vid: RIO vendor ID
63  * @did: RIO device ID
64  * @init_hook: Callback that performs switch-specific initialization
65  *
66  * Manipulating switch route tables and error management in RIO
67  * is switch specific. This registers a switch by vendor and device ID with
68  * initialization callback for setting up switch operations and (if required)
69  * hardware initialization. A &struct rio_switch_ops is initialized with
70  * pointer to the init routine and placed into a RIO-specific kernel section.
71  */
72 #define DECLARE_RIO_SWITCH_INIT(vid, did, init_hook)            \
73         DECLARE_RIO_SWITCH_SECTION(.rio_switch_ops, vid##did, \
74                         vid, did, init_hook)
75
76 #define RIO_GET_DID(size, x)    (size ? (x & 0xffff) : ((x & 0x00ff0000) >> 16))
77 #define RIO_SET_DID(size, x)    (size ? (x & 0xffff) : ((x & 0x000000ff) << 16))