[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / rapidio / rio.h

/*
 * RapidIO interconnect services
 *
 * Copyright 2005 MontaVista Software, Inc.
 * Matt Porter <mporter@kernel.crashing.org>
 *
 * 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 of the  License, or (at your
 * option) any later version.
 */

#include <linux/device.h>
#include <linux/list.h>
#include <linux/rio.h>

#define RIO_MAX_CHK_RETRY	3
#define RIO_MPORT_ANY		(-1)

/* Functions internal to the RIO core code */

extern u32 rio_mport_get_feature(struct rio_mport *mport, int local, u16 destid,
				 u8 hopcount, int ftr);
extern u32 rio_mport_get_physefb(struct rio_mport *port, int local,
				 u16 destid, u8 hopcount);
extern u32 rio_mport_get_efb(struct rio_mport *port, int local, u16 destid,
			     u8 hopcount, u32 from);
extern int rio_mport_chk_dev_access(struct rio_mport *mport, u16 destid,
				    u8 hopcount);
extern int rio_create_sysfs_dev_files(struct rio_dev *rdev);
extern int rio_std_route_add_entry(struct rio_mport *mport, u16 destid,
				   u8 hopcount, u16 table, u16 route_destid,
				   u8 route_port);
extern int rio_std_route_get_entry(struct rio_mport *mport, u16 destid,
				   u8 hopcount, u16 table, u16 route_destid,
				   u8 *route_port);
extern int rio_std_route_clr_table(struct rio_mport *mport, u16 destid,
				   u8 hopcount, u16 table);
extern int rio_set_port_lockout(struct rio_dev *rdev, u32 pnum, int lock);
extern struct rio_dev *rio_get_comptag(u32 comp_tag, struct rio_dev *from);
extern int rio_add_device(struct rio_dev *rdev);
extern void rio_switch_init(struct rio_dev *rdev, int do_enum);
extern int rio_enable_rx_tx_port(struct rio_mport *port, int local, u16 destid,
				 u8 hopcount, u8 port_num);
extern int rio_register_scan(int mport_id, struct rio_scan *scan_ops);
extern int rio_unregister_scan(int mport_id);
extern void rio_attach_device(struct rio_dev *rdev);
extern struct rio_mport *rio_find_mport(int mport_id);

/* Structures internal to the RIO core code */
extern struct device_attribute rio_dev_attrs[];
extern struct bus_attribute rio_bus_attrs[];

extern struct rio_switch_ops __start_rio_switch_ops[];
extern struct rio_switch_ops __end_rio_switch_ops[];

/* Helpers internal to the RIO core code */
#define DECLARE_RIO_SWITCH_SECTION(section, name, vid, did, init_hook) \
	static const struct rio_switch_ops __rio_switch_##name __used \
	__section(section) = { vid, did, init_hook };

/**
 * DECLARE_RIO_SWITCH_INIT - Registers switch initialization routine
 * @vid: RIO vendor ID
 * @did: RIO device ID
 * @init_hook: Callback that performs switch-specific initialization
 *
 * Manipulating switch route tables and error management in RIO
 * is switch specific. This registers a switch by vendor and device ID with
 * initialization callback for setting up switch operations and (if required)
 * hardware initialization. A &struct rio_switch_ops is initialized with
 * pointer to the init routine and placed into a RIO-specific kernel section.
 */
#define DECLARE_RIO_SWITCH_INIT(vid, did, init_hook)		\
	DECLARE_RIO_SWITCH_SECTION(.rio_switch_ops, vid##did, \
			vid, did, init_hook)

#define RIO_GET_DID(size, x)	(size ? (x & 0xffff) : ((x & 0x00ff0000) >> 16))
#define RIO_SET_DID(size, x)	(size ? (x & 0xffff) : ((x & 0x000000ff) << 16))
Commit	Line	Data
394b701c MP	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
6429cd49	17	#define RIO_MAX_CHK_RETRY 3
a11650e1	18	#define RIO_MPORT_ANY (-1)
6429cd49	19
394b701c MP	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);
e5cabeb3 AB	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);
e274e0ed AB	28	extern int rio_mport_chk_dev_access(struct rio_mport *mport, u16 destid,
e274e0ed AB	29	u8 hopcount);
394b701c	30	extern int rio_create_sysfs_dev_files(struct rio_dev *rdev);
07590ff0 AB	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);
e5cabeb3	39	extern int rio_set_port_lockout(struct rio_dev *rdev, u32 pnum, int lock);
af84ca38	40	extern struct rio_dev rio_get_comptag(u32 comp_tag, struct rio_dev from);
a11650e1 AB	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);
bc8fcfea	48	extern struct rio_mport *rio_find_mport(int mport_id);
394b701c MP	49
	50	/* Structures internal to the RIO core code */
	51	extern struct device_attribute rio_dev_attrs[];
bc8fcfea	52	extern struct bus_attribute rio_bus_attrs[];
394b701c	53
058f88d6 AB	54	extern struct rio_switch_ops __start_rio_switch_ops[];
058f88d6 AB	55	extern struct rio_switch_ops __end_rio_switch_ops[];
fa78cc51	56
394b701c	57	/* Helpers internal to the RIO core code */
058f88d6 AB	58	#define DECLARE_RIO_SWITCH_SECTION(section, name, vid, did, init_hook) \
	59	static const struct rio_switch_ops __rio_switch_##name __used \
	60	__section(section) = { vid, did, init_hook };
394b701c MP	61
394b701c MP	62	/**
058f88d6	63	* DECLARE_RIO_SWITCH_INIT - Registers switch initialization routine
394b701c MP	64	* @vid: RIO vendor ID
394b701c MP	65	* @did: RIO device ID
058f88d6	66	* @init_hook: Callback that performs switch-specific initialization
394b701c	67	*
058f88d6 AB	68	* Manipulating switch route tables and error management in RIO
	69	* is switch specific. This registers a switch by vendor and device ID with
	70	* initialization callback for setting up switch operations and (if required)
	71	* hardware initialization. A &struct rio_switch_ops is initialized with
	72	* pointer to the init routine and placed into a RIO-specific kernel section.
394b701c	73	*/
058f88d6 AB	74	#define DECLARE_RIO_SWITCH_INIT(vid, did, init_hook) \
	75	DECLARE_RIO_SWITCH_SECTION(.rio_switch_ops, vid##did, \
	76	vid, did, init_hook)
394b701c	77
e0423236 ZW	78	#define RIO_GET_DID(size, x) (size ? (x & 0xffff) : ((x & 0x00ff0000) >> 16))
e0423236 ZW	79	#define RIO_SET_DID(size, x) (size ? (x & 0xffff) : ((x & 0x000000ff) << 16))