xref: /openbmc/linux/drivers/rapidio/rio.h (revision a11650e11093ed57dca78bf16e7836517c599098)
1394b701cSMatt Porter /*
2394b701cSMatt Porter  * RapidIO interconnect services
3394b701cSMatt Porter  *
4394b701cSMatt Porter  * Copyright 2005 MontaVista Software, Inc.
5394b701cSMatt Porter  * Matt Porter <mporter@kernel.crashing.org>
6394b701cSMatt Porter  *
7394b701cSMatt Porter  * This program is free software; you can redistribute  it and/or modify it
8394b701cSMatt Porter  * under  the terms of  the GNU General  Public License as published by the
9394b701cSMatt Porter  * Free Software Foundation;  either version 2 of the  License, or (at your
10394b701cSMatt Porter  * option) any later version.
11394b701cSMatt Porter  */
12394b701cSMatt Porter 
13394b701cSMatt Porter #include <linux/device.h>
14394b701cSMatt Porter #include <linux/list.h>
15394b701cSMatt Porter #include <linux/rio.h>
16394b701cSMatt Porter 
176429cd49SAlexandre Bounine #define RIO_MAX_CHK_RETRY	3
18*a11650e1SAlexandre Bounine #define RIO_MPORT_ANY		(-1)
196429cd49SAlexandre Bounine 
20394b701cSMatt Porter /* Functions internal to the RIO core code */
21394b701cSMatt Porter 
22394b701cSMatt Porter extern u32 rio_mport_get_feature(struct rio_mport *mport, int local, u16 destid,
23394b701cSMatt Porter 				 u8 hopcount, int ftr);
24e5cabeb3SAlexandre Bounine extern u32 rio_mport_get_physefb(struct rio_mport *port, int local,
25e5cabeb3SAlexandre Bounine 				 u16 destid, u8 hopcount);
26e5cabeb3SAlexandre Bounine extern u32 rio_mport_get_efb(struct rio_mport *port, int local, u16 destid,
27e5cabeb3SAlexandre Bounine 			     u8 hopcount, u32 from);
28e274e0edSAlexandre Bounine extern int rio_mport_chk_dev_access(struct rio_mport *mport, u16 destid,
29e274e0edSAlexandre Bounine 				    u8 hopcount);
30394b701cSMatt Porter extern int rio_create_sysfs_dev_files(struct rio_dev *rdev);
3107590ff0SAlexandre Bounine extern int rio_std_route_add_entry(struct rio_mport *mport, u16 destid,
3207590ff0SAlexandre Bounine 				   u8 hopcount, u16 table, u16 route_destid,
3307590ff0SAlexandre Bounine 				   u8 route_port);
3407590ff0SAlexandre Bounine extern int rio_std_route_get_entry(struct rio_mport *mport, u16 destid,
3507590ff0SAlexandre Bounine 				   u8 hopcount, u16 table, u16 route_destid,
3607590ff0SAlexandre Bounine 				   u8 *route_port);
3707590ff0SAlexandre Bounine extern int rio_std_route_clr_table(struct rio_mport *mport, u16 destid,
3807590ff0SAlexandre Bounine 				   u8 hopcount, u16 table);
39e5cabeb3SAlexandre Bounine extern int rio_set_port_lockout(struct rio_dev *rdev, u32 pnum, int lock);
40af84ca38SAlexandre Bounine extern struct rio_dev *rio_get_comptag(u32 comp_tag, struct rio_dev *from);
41*a11650e1SAlexandre Bounine extern int rio_add_device(struct rio_dev *rdev);
42*a11650e1SAlexandre Bounine extern void rio_switch_init(struct rio_dev *rdev, int do_enum);
43*a11650e1SAlexandre Bounine extern int rio_enable_rx_tx_port(struct rio_mport *port, int local, u16 destid,
44*a11650e1SAlexandre Bounine 				 u8 hopcount, u8 port_num);
45*a11650e1SAlexandre Bounine extern int rio_register_scan(int mport_id, struct rio_scan *scan_ops);
46*a11650e1SAlexandre Bounine extern int rio_unregister_scan(int mport_id);
47*a11650e1SAlexandre Bounine extern void rio_attach_device(struct rio_dev *rdev);
48394b701cSMatt Porter 
49394b701cSMatt Porter /* Structures internal to the RIO core code */
50394b701cSMatt Porter extern struct device_attribute rio_dev_attrs[];
51394b701cSMatt Porter 
52058f88d6SAlexandre Bounine extern struct rio_switch_ops __start_rio_switch_ops[];
53058f88d6SAlexandre Bounine extern struct rio_switch_ops __end_rio_switch_ops[];
54fa78cc51SMatt Porter 
55394b701cSMatt Porter /* Helpers internal to the RIO core code */
56058f88d6SAlexandre Bounine #define DECLARE_RIO_SWITCH_SECTION(section, name, vid, did, init_hook) \
57058f88d6SAlexandre Bounine 	static const struct rio_switch_ops __rio_switch_##name __used \
58058f88d6SAlexandre Bounine 	__section(section) = { vid, did, init_hook };
59394b701cSMatt Porter 
60394b701cSMatt Porter /**
61058f88d6SAlexandre Bounine  * DECLARE_RIO_SWITCH_INIT - Registers switch initialization routine
62394b701cSMatt Porter  * @vid: RIO vendor ID
63394b701cSMatt Porter  * @did: RIO device ID
64058f88d6SAlexandre Bounine  * @init_hook: Callback that performs switch-specific initialization
65394b701cSMatt Porter  *
66058f88d6SAlexandre Bounine  * Manipulating switch route tables and error management in RIO
67058f88d6SAlexandre Bounine  * is switch specific. This registers a switch by vendor and device ID with
68058f88d6SAlexandre Bounine  * initialization callback for setting up switch operations and (if required)
69058f88d6SAlexandre Bounine  * hardware initialization. A &struct rio_switch_ops is initialized with
70058f88d6SAlexandre Bounine  * pointer to the init routine and placed into a RIO-specific kernel section.
71394b701cSMatt Porter  */
72058f88d6SAlexandre Bounine #define DECLARE_RIO_SWITCH_INIT(vid, did, init_hook)		\
73058f88d6SAlexandre Bounine 	DECLARE_RIO_SWITCH_SECTION(.rio_switch_ops, vid##did, \
74058f88d6SAlexandre Bounine 			vid, did, init_hook)
75394b701cSMatt Porter 
76e0423236SZhang Wei #define RIO_GET_DID(size, x)	(size ? (x & 0xffff) : ((x & 0x00ff0000) >> 16))
77e0423236SZhang Wei #define RIO_SET_DID(size, x)	(size ? (x & 0xffff) : ((x & 0x000000ff) << 16))
78