[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / ipack.h

/*
 * Industry-pack bus.
 *
 * Copyright (C) 2011-2012 CERN (www.cern.ch)
 * Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
 *
 * 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; version 2 of the License.
 */

#include <linux/mod_devicetable.h>
#include <linux/device.h>
#include <linux/interrupt.h>

#define IPACK_IDPROM_OFFSET_I			0x01
#define IPACK_IDPROM_OFFSET_P			0x03
#define IPACK_IDPROM_OFFSET_A			0x05
#define IPACK_IDPROM_OFFSET_C			0x07
#define IPACK_IDPROM_OFFSET_MANUFACTURER_ID	0x09
#define IPACK_IDPROM_OFFSET_MODEL		0x0B
#define IPACK_IDPROM_OFFSET_REVISION		0x0D
#define IPACK_IDPROM_OFFSET_RESERVED		0x0F
#define IPACK_IDPROM_OFFSET_DRIVER_ID_L		0x11
#define IPACK_IDPROM_OFFSET_DRIVER_ID_H		0x13
#define IPACK_IDPROM_OFFSET_NUM_BYTES		0x15
#define IPACK_IDPROM_OFFSET_CRC			0x17

/*
 * IndustryPack Fromat, Vendor and Device IDs.
 */

/* ID section format versions */
#define IPACK_ID_VERSION_INVALID	0x00
#define IPACK_ID_VERSION_1		0x01
#define IPACK_ID_VERSION_2		0x02

/* Vendors and devices. Sort key: vendor first, device next. */
#define IPACK1_VENDOR_ID_RESERVED1	0x00
#define IPACK1_VENDOR_ID_RESERVED2	0xFF
#define IPACK1_VENDOR_ID_UNREGISTRED01	0x01
#define IPACK1_VENDOR_ID_UNREGISTRED02	0x02
#define IPACK1_VENDOR_ID_UNREGISTRED03	0x03
#define IPACK1_VENDOR_ID_UNREGISTRED04	0x04
#define IPACK1_VENDOR_ID_UNREGISTRED05	0x05
#define IPACK1_VENDOR_ID_UNREGISTRED06	0x06
#define IPACK1_VENDOR_ID_UNREGISTRED07	0x07
#define IPACK1_VENDOR_ID_UNREGISTRED08	0x08
#define IPACK1_VENDOR_ID_UNREGISTRED09	0x09
#define IPACK1_VENDOR_ID_UNREGISTRED10	0x0A
#define IPACK1_VENDOR_ID_UNREGISTRED11	0x0B
#define IPACK1_VENDOR_ID_UNREGISTRED12	0x0C
#define IPACK1_VENDOR_ID_UNREGISTRED13	0x0D
#define IPACK1_VENDOR_ID_UNREGISTRED14	0x0E
#define IPACK1_VENDOR_ID_UNREGISTRED15	0x0F

#define IPACK1_VENDOR_ID_SBS            0xF0
#define IPACK1_DEVICE_ID_SBS_OCTAL_232  0x22
#define IPACK1_DEVICE_ID_SBS_OCTAL_422  0x2A
#define IPACK1_DEVICE_ID_SBS_OCTAL_485  0x48

struct ipack_bus_ops;
struct ipack_driver;

enum ipack_space {
	IPACK_IO_SPACE    = 0,
	IPACK_ID_SPACE,
	IPACK_INT_SPACE,
	IPACK_MEM8_SPACE,
	IPACK_MEM16_SPACE,
	/* Dummy for counting the number of entries.  Must remain the last
	 * entry */
	IPACK_SPACE_COUNT,
};

/**
 */
struct ipack_region {
	phys_addr_t start;
	size_t      size;
};

/**
 *	struct ipack_device
 *
 *	@slot: Slot where the device is plugged in the carrier board
 *	@bus: ipack_bus_device where the device is plugged to.
 *	@id_space: Virtual address to ID space.
 *	@io_space: Virtual address to IO space.
 *	@mem_space: Virtual address to MEM space.
 *	@dev: device in kernel representation.
 *
 * Warning: Direct access to mapped memory is possible but the endianness
 * is not the same with PCI carrier or VME carrier. The endianness is managed
 * by the carrier board throught bus->ops.
 */
struct ipack_device {
	unsigned int slot;
	struct ipack_bus_device *bus;
	struct device dev;
	void (*release) (struct ipack_device *dev);
	struct ipack_region      region[IPACK_SPACE_COUNT];
	u8                      *id;
	size_t			 id_avail;
	u32			 id_vendor;
	u32			 id_device;
	u8			 id_format;
	unsigned int		 id_crc_correct:1;
	unsigned int		 speed_8mhz:1;
	unsigned int		 speed_32mhz:1;
};

/**
 * struct ipack_driver_ops -- Callbacks to IPack device driver
 *
 * @probe:  Probe function
 * @remove: Prepare imminent removal of the device.  Services provided by the
 *          device should be revoked.
 */

struct ipack_driver_ops {
	int (*probe) (struct ipack_device *dev);
	void (*remove) (struct ipack_device *dev);
};

/**
 * struct ipack_driver -- Specific data to each ipack device driver
 *
 * @driver: Device driver kernel representation
 * @ops:    Callbacks provided by the IPack device driver
 */
struct ipack_driver {
	struct device_driver driver;
	const struct ipack_device_id *id_table;
	const struct ipack_driver_ops *ops;
};

/**
 *	struct ipack_bus_ops - available operations on a bridge module
 *
 *	@map_space: map IP address space
 *	@unmap_space: unmap IP address space
 *	@request_irq: request IRQ
 *	@free_irq: free IRQ
 *	@get_clockrate: Returns the clockrate the carrier is currently
 *		communicating with the device at.
 *	@set_clockrate: Sets the clock-rate for carrier / module communication.
 *		Should return -EINVAL if the requested speed is not supported.
 *	@get_error: Returns the error state for the slot the device is attached
 *		to.
 *	@get_timeout: Returns 1 if the communication with the device has
 *		previously timed out.
 *	@reset_timeout: Resets the state returned by get_timeout.
 */
struct ipack_bus_ops {
	int (*request_irq) (struct ipack_device *dev,
			    irqreturn_t (*handler)(void *), void *arg);
	int (*free_irq) (struct ipack_device *dev);
	int (*get_clockrate) (struct ipack_device *dev);
	int (*set_clockrate) (struct ipack_device *dev, int mherz);
	int (*get_error) (struct ipack_device *dev);
	int (*get_timeout) (struct ipack_device *dev);
	int (*reset_timeout) (struct ipack_device *dev);
};

/**
 *	struct ipack_bus_device
 *
 *	@dev: pointer to carrier device
 *	@slots: number of slots available
 *	@bus_nr: ipack bus number
 *	@ops: bus operations for the mezzanine drivers
 */
struct ipack_bus_device {
	struct device *parent;
	int slots;
	int bus_nr;
	const struct ipack_bus_ops *ops;
};

/**
 *	ipack_bus_register -- register a new ipack bus
 *
 * @parent: pointer to the parent device, if any.
 * @slots: number of slots available in the bus device.
 * @ops: bus operations for the mezzanine drivers.
 *
 * The carrier board device should call this function to register itself as
 * available bus device in ipack.
 */
struct ipack_bus_device *ipack_bus_register(struct device *parent, int slots,
					    const struct ipack_bus_ops *ops);

/**
 *	ipack_bus_unregister -- unregister an ipack bus
 */
int ipack_bus_unregister(struct ipack_bus_device *bus);

/**
 * ipack_driver_register -- Register a new ipack device driver
 *
 * Called by a ipack driver to register itself as a driver
 * that can manage ipack devices.
 */
int ipack_driver_register(struct ipack_driver *edrv, struct module *owner,
			  const char *name);
void ipack_driver_unregister(struct ipack_driver *edrv);

/**
 *	ipack_device_init -- initialize an IPack device
 * @dev: the new device to initialize.
 *
 * Initialize a new IPack device ("module" in IndustryPack jargon). The call
 * is done by the carrier driver.  The carrier should populate the fields
 * bus and slot as well as the region array of @dev prior to calling this
 * function.  The rest of the fields will be allocated and populated
 * during initalization.
 *
 * Return zero on success or error code on failure.
 *
 * NOTE: _Never_ directly free @dev after calling this function, even
 * if it returned an error! Always use ipack_put_device() to give up the
 * reference initialized in this function instead.
 */
int ipack_device_init(struct ipack_device *dev);

/**
 *	ipack_device_add -- Add an IPack device
 * @dev: the new device to add.
 *
 * Add a new IPack device. The call is done by the carrier driver
 * after calling ipack_device_init().
 *
 * Return zero on success or error code on failure.
 *
 * NOTE: _Never_ directly free @dev after calling this function, even
 * if it returned an error! Always use ipack_put_device() to give up the
 * reference initialized in this function instead.
 */
int ipack_device_add(struct ipack_device *dev);
void ipack_device_del(struct ipack_device *dev);

void ipack_get_device(struct ipack_device *dev);
void ipack_put_device(struct ipack_device *dev);

/**
 * DEFINE_IPACK_DEVICE_TABLE - macro used to describe a IndustryPack table
 * @_table: device table name
 *
 * This macro is used to create a struct ipack_device_id array (a device table)
 * in a generic manner.
 */
#define DEFINE_IPACK_DEVICE_TABLE(_table) \
	const struct ipack_device_id _table[]
/**
 * IPACK_DEVICE - macro used to describe a specific IndustryPack device
 * @_format: the format version (currently either 1 or 2, 8 bit value)
 * @vend:    the 8 or 24 bit IndustryPack Vendor ID
 * @dev:     the 8 or 16  bit IndustryPack Device ID
 *
 * This macro is used to create a struct ipack_device_id that matches a specific
 * device.
 */
#define IPACK_DEVICE(_format, vend, dev) \
	 .format = (_format), \
	 .vendor = (vend), \
	 .device = (dev)
Commit	Line	Data
d3465872 SIG	1	/*
	2	* Industry-pack bus.
	3	*
76859725 SIG	4	* Copyright (C) 2011-2012 CERN (www.cern.ch)
76859725 SIG	5	* Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
d3465872 SIG	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 Free
416289b1	9	* Software Foundation; version 2 of the License.
d3465872 SIG	10	*/
d3465872 SIG	11
849e0ad2	12	#include <linux/mod_devicetable.h>
d3465872	13	#include <linux/device.h>
faa75c40	14	#include <linux/interrupt.h>
d3465872	15
d3465872 SIG	16	#define IPACK_IDPROM_OFFSET_I 0x01
	17	#define IPACK_IDPROM_OFFSET_P 0x03
	18	#define IPACK_IDPROM_OFFSET_A 0x05
	19	#define IPACK_IDPROM_OFFSET_C 0x07
	20	#define IPACK_IDPROM_OFFSET_MANUFACTURER_ID 0x09
	21	#define IPACK_IDPROM_OFFSET_MODEL 0x0B
	22	#define IPACK_IDPROM_OFFSET_REVISION 0x0D
	23	#define IPACK_IDPROM_OFFSET_RESERVED 0x0F
	24	#define IPACK_IDPROM_OFFSET_DRIVER_ID_L 0x11
	25	#define IPACK_IDPROM_OFFSET_DRIVER_ID_H 0x13
	26	#define IPACK_IDPROM_OFFSET_NUM_BYTES 0x15
	27	#define IPACK_IDPROM_OFFSET_CRC 0x17
	28
27cf2d1b SIG	29	/*
	30	* IndustryPack Fromat, Vendor and Device IDs.
	31	*/
	32
	33	/* ID section format versions */
	34	#define IPACK_ID_VERSION_INVALID 0x00
	35	#define IPACK_ID_VERSION_1 0x01
	36	#define IPACK_ID_VERSION_2 0x02
	37
	38	/* Vendors and devices. Sort key: vendor first, device next. */
	39	#define IPACK1_VENDOR_ID_RESERVED1 0x00
	40	#define IPACK1_VENDOR_ID_RESERVED2 0xFF
	41	#define IPACK1_VENDOR_ID_UNREGISTRED01 0x01
	42	#define IPACK1_VENDOR_ID_UNREGISTRED02 0x02
	43	#define IPACK1_VENDOR_ID_UNREGISTRED03 0x03
	44	#define IPACK1_VENDOR_ID_UNREGISTRED04 0x04
	45	#define IPACK1_VENDOR_ID_UNREGISTRED05 0x05
	46	#define IPACK1_VENDOR_ID_UNREGISTRED06 0x06
	47	#define IPACK1_VENDOR_ID_UNREGISTRED07 0x07
	48	#define IPACK1_VENDOR_ID_UNREGISTRED08 0x08
	49	#define IPACK1_VENDOR_ID_UNREGISTRED09 0x09
	50	#define IPACK1_VENDOR_ID_UNREGISTRED10 0x0A
	51	#define IPACK1_VENDOR_ID_UNREGISTRED11 0x0B
	52	#define IPACK1_VENDOR_ID_UNREGISTRED12 0x0C
	53	#define IPACK1_VENDOR_ID_UNREGISTRED13 0x0D
	54	#define IPACK1_VENDOR_ID_UNREGISTRED14 0x0E
	55	#define IPACK1_VENDOR_ID_UNREGISTRED15 0x0F
	56
	57	#define IPACK1_VENDOR_ID_SBS 0xF0
	58	#define IPACK1_DEVICE_ID_SBS_OCTAL_232 0x22
	59	#define IPACK1_DEVICE_ID_SBS_OCTAL_422 0x2A
	60	#define IPACK1_DEVICE_ID_SBS_OCTAL_485 0x48
	61
d3465872 SIG	62	struct ipack_bus_ops;
	63	struct ipack_driver;
	64
	65	enum ipack_space {
	66	IPACK_IO_SPACE = 0,
84a08fa9	67	IPACK_ID_SPACE,
e4af9497	68	IPACK_INT_SPACE,
fe4a3ed0	69	IPACK_MEM8_SPACE,
48a97352	70	IPACK_MEM16_SPACE,
84a08fa9 JT	71	/* Dummy for counting the number of entries. Must remain the last
	72	* entry */
	73	IPACK_SPACE_COUNT,
d3465872 SIG	74	};
d3465872 SIG	75
bb29ab86 JT	76	/**
	77	*/
	78	struct ipack_region {
	79	phys_addr_t start;
	80	size_t size;
	81	};
	82
d3465872 SIG	83	/**
	84	* struct ipack_device
	85	*
d3465872	86	* @slot: Slot where the device is plugged in the carrier board
ec440335	87	* @bus: ipack_bus_device where the device is plugged to.
d3465872 SIG	88	* @id_space: Virtual address to ID space.
	89	* @io_space: Virtual address to IO space.
	90	* @mem_space: Virtual address to MEM space.
	91	* @dev: device in kernel representation.
	92	*
	93	* Warning: Direct access to mapped memory is possible but the endianness
	94	* is not the same with PCI carrier or VME carrier. The endianness is managed
ec440335	95	* by the carrier board throught bus->ops.
d3465872 SIG	96	*/
d3465872 SIG	97	struct ipack_device {
d3465872	98	unsigned int slot;
ec440335	99	struct ipack_bus_device *bus;
d3465872	100	struct device dev;
1e91795c	101	void (release) (struct ipack_device dev);
a19ad7d0	102	struct ipack_region region[IPACK_SPACE_COUNT];
e8ed3276	103	u8 *id;
187e4782	104	size_t id_avail;
e8ed3276 JT	105	u32 id_vendor;
e8ed3276 JT	106	u32 id_device;
187e4782	107	u8 id_format;
a92caeb8	108	unsigned int id_crc_correct:1;
0b0f3a1b JT	109	unsigned int speed_8mhz:1;
0b0f3a1b JT	110	unsigned int speed_32mhz:1;
d3465872 SIG	111	};
d3465872 SIG	112
ec440335	113	/**
26c295cb	114	* struct ipack_driver_ops -- Callbacks to IPack device driver
d3465872	115	*
26c295cb JT	116	* @probe: Probe function
	117	* @remove: Prepare imminent removal of the device. Services provided by the
	118	* device should be revoked.
d3465872 SIG	119	*/
	120
	121	struct ipack_driver_ops {
d3465872 SIG	122	int (probe) (struct ipack_device dev);
	123	void (remove) (struct ipack_device dev);
	124	};
	125
	126	/**
26c295cb	127	* struct ipack_driver -- Specific data to each ipack device driver
d3465872	128	*
26c295cb JT	129	* @driver: Device driver kernel representation
26c295cb JT	130	* @ops: Callbacks provided by the IPack device driver
d3465872 SIG	131	*/
d3465872 SIG	132	struct ipack_driver {
d3465872	133	struct device_driver driver;
849e0ad2	134	const struct ipack_device_id *id_table;
e8011135	135	const struct ipack_driver_ops *ops;
d3465872 SIG	136	};
d3465872 SIG	137
d3465872 SIG	138	/**
	139	* struct ipack_bus_ops - available operations on a bridge module
	140	*
	141	* @map_space: map IP address space
	142	* @unmap_space: unmap IP address space
	143	* @request_irq: request IRQ
	144	* @free_irq: free IRQ
7b6ab33c JT	145	* @get_clockrate: Returns the clockrate the carrier is currently
	146	* communicating with the device at.
	147	* @set_clockrate: Sets the clock-rate for carrier / module communication.
	148	* Should return -EINVAL if the requested speed is not supported.
	149	* @get_error: Returns the error state for the slot the device is attached
	150	* to.
	151	* @get_timeout: Returns 1 if the communication with the device has
	152	* previously timed out.
	153	* @reset_timeout: Resets the state returned by get_timeout.
d3465872 SIG	154	*/
d3465872 SIG	155	struct ipack_bus_ops {
c6e2dfaa	156	int (request_irq) (struct ipack_device dev,
faa75c40	157	irqreturn_t (handler)(void ), void *arg);
d3465872	158	int (free_irq) (struct ipack_device dev);
7b6ab33c JT	159	int (get_clockrate) (struct ipack_device dev);
	160	int (set_clockrate) (struct ipack_device dev, int mherz);
	161	int (get_error) (struct ipack_device dev);
	162	int (get_timeout) (struct ipack_device dev);
	163	int (reset_timeout) (struct ipack_device dev);
d3465872 SIG	164	};
	165
	166	/**
	167	* struct ipack_bus_device
	168	*
	169	* @dev: pointer to carrier device
	170	* @slots: number of slots available
	171	* @bus_nr: ipack bus number
ec440335	172	* @ops: bus operations for the mezzanine drivers
d3465872 SIG	173	*/
d3465872 SIG	174	struct ipack_bus_device {
ec440335	175	struct device *parent;
d3465872 SIG	176	int slots;
d3465872 SIG	177	int bus_nr;
9869a937	178	const struct ipack_bus_ops *ops;
d3465872 SIG	179	};
	180
	181	/**
	182	* ipack_bus_register -- register a new ipack bus
	183	*
ec440335 SIG	184	* @parent: pointer to the parent device, if any.
	185	* @slots: number of slots available in the bus device.
	186	* @ops: bus operations for the mezzanine drivers.
	187	*
	188	* The carrier board device should call this function to register itself as
	189	* available bus device in ipack.
d3465872	190	*/
ec440335	191	struct ipack_bus_device ipack_bus_register(struct device parent, int slots,
9869a937	192	const struct ipack_bus_ops *ops);
d3465872 SIG	193
	194	/**
	195	* ipack_bus_unregister -- unregister an ipack bus
	196	*/
	197	int ipack_bus_unregister(struct ipack_bus_device *bus);
ec440335 SIG	198
ec440335 SIG	199	/**
26c295cb	200	* ipack_driver_register -- Register a new ipack device driver
ec440335 SIG	201	*
	202	* Called by a ipack driver to register itself as a driver
	203	* that can manage ipack devices.
	204	*/
9869a937 SH	205	int ipack_driver_register(struct ipack_driver edrv, struct module owner,
9869a937 SH	206	const char *name);
ec440335 SIG	207	void ipack_driver_unregister(struct ipack_driver *edrv);
	208
	209	/**
e926301b SIG	210	* ipack_device_init -- initialize an IPack device
e926301b SIG	211	* @dev: the new device to initialize.
ec440335	212	*
e926301b SIG	213	* Initialize a new IPack device ("module" in IndustryPack jargon). The call
	214	* is done by the carrier driver. The carrier should populate the fields
	215	* bus and slot as well as the region array of @dev prior to calling this
	216	* function. The rest of the fields will be allocated and populated
	217	* during initalization.
ec440335	218	*
e926301b SIG	219	* Return zero on success or error code on failure.
	220	*
	221	* NOTE: _Never_ directly free @dev after calling this function, even
	222	* if it returned an error! Always use ipack_put_device() to give up the
	223	* reference initialized in this function instead.
	224	*/
	225	int ipack_device_init(struct ipack_device *dev);
	226
	227	/**
	228	* ipack_device_add -- Add an IPack device
	229	* @dev: the new device to add.
	230	*
	231	* Add a new IPack device. The call is done by the carrier driver
	232	* after calling ipack_device_init().
	233	*
	234	* Return zero on success or error code on failure.
	235	*
	236	* NOTE: _Never_ directly free @dev after calling this function, even
	237	* if it returned an error! Always use ipack_put_device() to give up the
	238	* reference initialized in this function instead.
ec440335	239	*/
e926301b SIG	240	int ipack_device_add(struct ipack_device *dev);
e926301b SIG	241	void ipack_device_del(struct ipack_device *dev);
849e0ad2	242
fa882867 SIG	243	void ipack_get_device(struct ipack_device *dev);
	244	void ipack_put_device(struct ipack_device *dev);
	245
849e0ad2 JT	246	/**
	247	* DEFINE_IPACK_DEVICE_TABLE - macro used to describe a IndustryPack table
	248	* @_table: device table name
	249	*
	250	* This macro is used to create a struct ipack_device_id array (a device table)
	251	* in a generic manner.
	252	*/
	253	#define DEFINE_IPACK_DEVICE_TABLE(_table) \
d79251f0	254	const struct ipack_device_id _table[]
849e0ad2 JT	255	/**
	256	* IPACK_DEVICE - macro used to describe a specific IndustryPack device
	257	* @_format: the format version (currently either 1 or 2, 8 bit value)
	258	* @vend: the 8 or 24 bit IndustryPack Vendor ID
	259	* @dev: the 8 or 16 bit IndustryPack Device ID
	260	*
	261	* This macro is used to create a struct ipack_device_id that matches a specific
	262	* device.
	263	*/
	264	#define IPACK_DEVICE(_format, vend, dev) \
	265	.format = (_format), \
	266	.vendor = (vend), \
	267	.device = (dev)