[linux-2.6-block.git] / include / linux / usb / renesas_usbhs.h

/*
 * Renesas USB
 *
 * Copyright (C) 2011 Renesas Solutions Corp.
 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
#ifndef RENESAS_USB_H
#define RENESAS_USB_H
#include <linux/platform_device.h>
#include <linux/usb/ch9.h>

/*
 * module type
 *
 * it will be return value from get_id
 */
enum {
	USBHS_HOST = 0,
	USBHS_GADGET,
	USBHS_MAX,
};

/*
 * callback functions table for driver
 *
 * These functions are called from platform for driver.
 * Callback function's pointer will be set before
 * renesas_usbhs_platform_callback :: hardware_init was called
 */
struct renesas_usbhs_driver_callback {
	int (*notify_hotplug)(struct platform_device *pdev);
};

/*
 * callback functions for platform
 *
 * These functions are called from driver for platform
 */
struct renesas_usbhs_platform_callback {

	/*
	 * option:
	 *
	 * Hardware init function for platform.
	 * it is called when driver was probed.
	 */
	int (*hardware_init)(struct platform_device *pdev);

	/*
	 * option:
	 *
	 * Hardware exit function for platform.
	 * it is called when driver was removed
	 */
	void (*hardware_exit)(struct platform_device *pdev);

	/*
	 * option:
	 *
	 * for board specific clock control
	 */
	void (*power_ctrl)(struct platform_device *pdev,
			   void __iomem *base, int enable);

	/*
	 * option:
	 *
	 * Phy reset for platform
	 */
	void (*phy_reset)(struct platform_device *pdev);

	/*
	 * get USB ID function
	 *  - USBHS_HOST
	 *  - USBHS_GADGET
	 */
	int (*get_id)(struct platform_device *pdev);

	/*
	 * get VBUS status function.
	 */
	int (*get_vbus)(struct platform_device *pdev);

	/*
	 * option:
	 *
	 * VBUS control is needed for Host
	 */
	int (*set_vbus)(struct platform_device *pdev, int enable);
};

/*
 * parameters for renesas usbhs
 *
 * some register needs USB chip specific parameters.
 * This struct show it to driver
 */
struct renesas_usbhs_driver_param {
	/*
	 * pipe settings
	 */
	u32 *pipe_type; /* array of USB_ENDPOINT_XFER_xxx (from ep0) */
	int pipe_size; /* pipe_type array size */

	/*
	 * option:
	 *
	 * for BUSWAIT :: BWAIT
	 * see
	 *	renesas_usbhs/common.c :: usbhsc_set_buswait()
	 * */
	int buswait_bwait;

	/*
	 * option:
	 *
	 * delay time from notify_hotplug callback
	 */
	int detection_delay; /* msec */

	/*
	 * option:
	 *
	 * dma id for dmaengine
	 */
	int d0_tx_id;
	int d0_rx_id;
	int d1_tx_id;
	int d1_rx_id;

	/*
	 * option:
	 *
	 * pio <--> dma border.
	 */
	int pio_dma_border; /* default is 64byte */

	/*
	 * option:
	 */
	u32 has_otg:1; /* for controlling PWEN/EXTLP */
	u32 has_sudmac:1; /* for SUDMAC */
};

/*
 * option:
 *
 * platform information for renesas_usbhs driver.
 */
struct renesas_usbhs_platform_info {
	/*
	 * option:
	 *
	 * platform set these functions before
	 * call platform_add_devices if needed
	 */
	struct renesas_usbhs_platform_callback	platform_callback;

	/*
	 * driver set these callback functions pointer.
	 * platform can use it on callback functions
	 */
	struct renesas_usbhs_driver_callback	driver_callback;

	/*
	 * option:
	 *
	 * driver use these param for some register
	 */
	struct renesas_usbhs_driver_param	driver_param;
};

/*
 * macro for platform
 */
#define renesas_usbhs_get_info(pdev)\
	((struct renesas_usbhs_platform_info *)(pdev)->dev.platform_data)

#define renesas_usbhs_call_notify_hotplug(pdev)				\
	({								\
		struct renesas_usbhs_driver_callback *dc;		\
		dc = &(renesas_usbhs_get_info(pdev)->driver_callback);	\
		if (dc && dc->notify_hotplug)				\
			dc->notify_hotplug(pdev);			\
	})
#endif /* RENESAS_USB_H */
Commit	Line	Data
f1407d5c KM	1	/*
	2	* Renesas USB
	3	*
	4	* Copyright (C) 2011 Renesas Solutions Corp.
	5	* Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
	6	*
	7	* This program is distributed in the hope that it will be useful,
	8	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	9	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	10	* GNU General Public License for more details.
	11	*
	12	* You should have received a copy of the GNU General Public License
	13	* along with this program; if not, write to the Free Software
	14	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	15	*
	16	*/
	17	#ifndef RENESAS_USB_H
	18	#define RENESAS_USB_H
	19	#include <linux/platform_device.h>
	20	#include <linux/usb/ch9.h>
	21
	22	/*
	23	* module type
	24	*
	25	* it will be return value from get_id
	26	*/
	27	enum {
	28	USBHS_HOST = 0,
	29	USBHS_GADGET,
	30	USBHS_MAX,
	31	};
	32
	33	/*
	34	* callback functions table for driver
	35	*
	36	* These functions are called from platform for driver.
	37	* Callback function's pointer will be set before
	38	* renesas_usbhs_platform_callback :: hardware_init was called
	39	*/
	40	struct renesas_usbhs_driver_callback {
	41	int (notify_hotplug)(struct platform_device pdev);
	42	};
	43
	44	/*
	45	* callback functions for platform
	46	*
	47	* These functions are called from driver for platform
	48	*/
	49	struct renesas_usbhs_platform_callback {
	50
	51	/*
	52	* option:
	53	*
	54	* Hardware init function for platform.
	55	* it is called when driver was probed.
	56	*/
	57	int (hardware_init)(struct platform_device pdev);
	58
	59	/*
	60	* option:
	61	*
	62	* Hardware exit function for platform.
	63	* it is called when driver was removed
	64	*/
65	void (hardware_exit)(struct platform_device pdev);
66
f1ee56a0 KM	67	/*
	68	* option:
	69	*
	70	* for board specific clock control
	71	*/
	72	void (power_ctrl)(struct platform_device pdev,
	73	void __iomem *base, int enable);
	74
f1407d5c KM	75	/*
	76	* option:
	77	*
	78	* Phy reset for platform
	79	*/
	80	void (phy_reset)(struct platform_device pdev);
	81
	82	/*
	83	* get USB ID function
	84	* - USBHS_HOST
	85	* - USBHS_GADGET
	86	*/
	87	int (get_id)(struct platform_device pdev);
	88
	89	/*
	90	* get VBUS status function.
	91	*/
	92	int (get_vbus)(struct platform_device pdev);
258485d9 KM	93
	94	/*
	95	* option:
	96	*
	97	* VBUS control is needed for Host
	98	*/
	99	int (set_vbus)(struct platform_device pdev, int enable);
f1407d5c KM	100	};
	101
	102	/*
	103	* parameters for renesas usbhs
	104	*
	105	* some register needs USB chip specific parameters.
	106	* This struct show it to driver
	107	*/
	108	struct renesas_usbhs_driver_param {
	109	/*
	110	* pipe settings
	111	*/
	112	u32 pipe_type; / array of USB_ENDPOINT_XFER_xxx (from ep0) */
	113	int pipe_size; /* pipe_type array size */
	114
	115	/*
	116	* option:
	117	*
	118	* for BUSWAIT :: BWAIT
11935de5 KM	119	* see
11935de5 KM	120	* renesas_usbhs/common.c :: usbhsc_set_buswait()
f1407d5c KM	121	* */
f1407d5c KM	122	int buswait_bwait;
bc57381e KM	123
	124	/*
	125	* option:
	126	*
	127	* delay time from notify_hotplug callback
	128	*/
a49a88f1	129	int detection_delay; /* msec */
e73a9891 KM	130
	131	/*
	132	* option:
	133	*
	134	* dma id for dmaengine
	135	*/
	136	int d0_tx_id;
	137	int d0_rx_id;
	138	int d1_tx_id;
	139	int d1_rx_id;
	140
	141	/*
	142	* option:
	143	*
	144	* pio <--> dma border.
	145	*/
	146	int pio_dma_border; /* default is 64byte */
f427eb64 KM	147
	148	/*
	149	* option:
	150	*/
	151	u32 has_otg:1; /* for controlling PWEN/EXTLP */
5ea43994	152	u32 has_sudmac:1; /* for SUDMAC */
f1407d5c KM	153	};
	154
	155	/*
	156	* option:
	157	*
	158	* platform information for renesas_usbhs driver.
	159	*/
	160	struct renesas_usbhs_platform_info {
	161	/*
	162	* option:
	163	*
	164	* platform set these functions before
	165	* call platform_add_devices if needed
	166	*/
	167	struct renesas_usbhs_platform_callback platform_callback;
	168
	169	/*
	170	* driver set these callback functions pointer.
	171	* platform can use it on callback functions
	172	*/
	173	struct renesas_usbhs_driver_callback driver_callback;
	174
	175	/*
	176	* option:
	177	*
	178	* driver use these param for some register
	179	*/
	180	struct renesas_usbhs_driver_param driver_param;
	181	};
	182
	183	/*
	184	* macro for platform
	185	*/
	186	#define renesas_usbhs_get_info(pdev)\
	187	((struct renesas_usbhs_platform_info *)(pdev)->dev.platform_data)
	188
	189	#define renesas_usbhs_call_notify_hotplug(pdev) \
	190	({ \
	191	struct renesas_usbhs_driver_callback *dc; \
	192	dc = &(renesas_usbhs_get_info(pdev)->driver_callback); \
af32fe51	193	if (dc && dc->notify_hotplug) \
f1407d5c KM	194	dc->notify_hotplug(pdev); \
	195	})
	196	#endif /* RENESAS_USB_H */