5653668c95
Other USB drivers may want to use OTG final state machine implementation, so make this header available for them. Signed-off-by: Anton Tikhomirov <av.tikhomirov@samsung.com> Signed-off-by: Felipe Balbi <balbi@ti.com>
406 lines
14 KiB
C
406 lines
14 KiB
C
/* Copyright (C) 2007,2008 Freescale Semiconductor, Inc.
|
|
*
|
|
* 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.
|
|
*
|
|
* 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.,
|
|
* 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
|
|
#include <linux/usb/otg-fsm.h>
|
|
#include <linux/usb/otg.h>
|
|
#include <linux/ioctl.h>
|
|
|
|
/* USB Command Register Bit Masks */
|
|
#define USB_CMD_RUN_STOP (0x1<<0)
|
|
#define USB_CMD_CTRL_RESET (0x1<<1)
|
|
#define USB_CMD_PERIODIC_SCHEDULE_EN (0x1<<4)
|
|
#define USB_CMD_ASYNC_SCHEDULE_EN (0x1<<5)
|
|
#define USB_CMD_INT_AA_DOORBELL (0x1<<6)
|
|
#define USB_CMD_ASP (0x3<<8)
|
|
#define USB_CMD_ASYNC_SCH_PARK_EN (0x1<<11)
|
|
#define USB_CMD_SUTW (0x1<<13)
|
|
#define USB_CMD_ATDTW (0x1<<14)
|
|
#define USB_CMD_ITC (0xFF<<16)
|
|
|
|
/* bit 15,3,2 are frame list size */
|
|
#define USB_CMD_FRAME_SIZE_1024 (0x0<<15 | 0x0<<2)
|
|
#define USB_CMD_FRAME_SIZE_512 (0x0<<15 | 0x1<<2)
|
|
#define USB_CMD_FRAME_SIZE_256 (0x0<<15 | 0x2<<2)
|
|
#define USB_CMD_FRAME_SIZE_128 (0x0<<15 | 0x3<<2)
|
|
#define USB_CMD_FRAME_SIZE_64 (0x1<<15 | 0x0<<2)
|
|
#define USB_CMD_FRAME_SIZE_32 (0x1<<15 | 0x1<<2)
|
|
#define USB_CMD_FRAME_SIZE_16 (0x1<<15 | 0x2<<2)
|
|
#define USB_CMD_FRAME_SIZE_8 (0x1<<15 | 0x3<<2)
|
|
|
|
/* bit 9-8 are async schedule park mode count */
|
|
#define USB_CMD_ASP_00 (0x0<<8)
|
|
#define USB_CMD_ASP_01 (0x1<<8)
|
|
#define USB_CMD_ASP_10 (0x2<<8)
|
|
#define USB_CMD_ASP_11 (0x3<<8)
|
|
#define USB_CMD_ASP_BIT_POS (8)
|
|
|
|
/* bit 23-16 are interrupt threshold control */
|
|
#define USB_CMD_ITC_NO_THRESHOLD (0x00<<16)
|
|
#define USB_CMD_ITC_1_MICRO_FRM (0x01<<16)
|
|
#define USB_CMD_ITC_2_MICRO_FRM (0x02<<16)
|
|
#define USB_CMD_ITC_4_MICRO_FRM (0x04<<16)
|
|
#define USB_CMD_ITC_8_MICRO_FRM (0x08<<16)
|
|
#define USB_CMD_ITC_16_MICRO_FRM (0x10<<16)
|
|
#define USB_CMD_ITC_32_MICRO_FRM (0x20<<16)
|
|
#define USB_CMD_ITC_64_MICRO_FRM (0x40<<16)
|
|
#define USB_CMD_ITC_BIT_POS (16)
|
|
|
|
/* USB Status Register Bit Masks */
|
|
#define USB_STS_INT (0x1<<0)
|
|
#define USB_STS_ERR (0x1<<1)
|
|
#define USB_STS_PORT_CHANGE (0x1<<2)
|
|
#define USB_STS_FRM_LST_ROLL (0x1<<3)
|
|
#define USB_STS_SYS_ERR (0x1<<4)
|
|
#define USB_STS_IAA (0x1<<5)
|
|
#define USB_STS_RESET_RECEIVED (0x1<<6)
|
|
#define USB_STS_SOF (0x1<<7)
|
|
#define USB_STS_DCSUSPEND (0x1<<8)
|
|
#define USB_STS_HC_HALTED (0x1<<12)
|
|
#define USB_STS_RCL (0x1<<13)
|
|
#define USB_STS_PERIODIC_SCHEDULE (0x1<<14)
|
|
#define USB_STS_ASYNC_SCHEDULE (0x1<<15)
|
|
|
|
/* USB Interrupt Enable Register Bit Masks */
|
|
#define USB_INTR_INT_EN (0x1<<0)
|
|
#define USB_INTR_ERR_INT_EN (0x1<<1)
|
|
#define USB_INTR_PC_DETECT_EN (0x1<<2)
|
|
#define USB_INTR_FRM_LST_ROLL_EN (0x1<<3)
|
|
#define USB_INTR_SYS_ERR_EN (0x1<<4)
|
|
#define USB_INTR_ASYN_ADV_EN (0x1<<5)
|
|
#define USB_INTR_RESET_EN (0x1<<6)
|
|
#define USB_INTR_SOF_EN (0x1<<7)
|
|
#define USB_INTR_DEVICE_SUSPEND (0x1<<8)
|
|
|
|
/* Device Address bit masks */
|
|
#define USB_DEVICE_ADDRESS_MASK (0x7F<<25)
|
|
#define USB_DEVICE_ADDRESS_BIT_POS (25)
|
|
/* PORTSC Register Bit Masks,Only one PORT in OTG mode*/
|
|
#define PORTSC_CURRENT_CONNECT_STATUS (0x1<<0)
|
|
#define PORTSC_CONNECT_STATUS_CHANGE (0x1<<1)
|
|
#define PORTSC_PORT_ENABLE (0x1<<2)
|
|
#define PORTSC_PORT_EN_DIS_CHANGE (0x1<<3)
|
|
#define PORTSC_OVER_CURRENT_ACT (0x1<<4)
|
|
#define PORTSC_OVER_CUURENT_CHG (0x1<<5)
|
|
#define PORTSC_PORT_FORCE_RESUME (0x1<<6)
|
|
#define PORTSC_PORT_SUSPEND (0x1<<7)
|
|
#define PORTSC_PORT_RESET (0x1<<8)
|
|
#define PORTSC_LINE_STATUS_BITS (0x3<<10)
|
|
#define PORTSC_PORT_POWER (0x1<<12)
|
|
#define PORTSC_PORT_INDICTOR_CTRL (0x3<<14)
|
|
#define PORTSC_PORT_TEST_CTRL (0xF<<16)
|
|
#define PORTSC_WAKE_ON_CONNECT_EN (0x1<<20)
|
|
#define PORTSC_WAKE_ON_CONNECT_DIS (0x1<<21)
|
|
#define PORTSC_WAKE_ON_OVER_CURRENT (0x1<<22)
|
|
#define PORTSC_PHY_LOW_POWER_SPD (0x1<<23)
|
|
#define PORTSC_PORT_FORCE_FULL_SPEED (0x1<<24)
|
|
#define PORTSC_PORT_SPEED_MASK (0x3<<26)
|
|
#define PORTSC_TRANSCEIVER_WIDTH (0x1<<28)
|
|
#define PORTSC_PHY_TYPE_SEL (0x3<<30)
|
|
/* bit 11-10 are line status */
|
|
#define PORTSC_LINE_STATUS_SE0 (0x0<<10)
|
|
#define PORTSC_LINE_STATUS_JSTATE (0x1<<10)
|
|
#define PORTSC_LINE_STATUS_KSTATE (0x2<<10)
|
|
#define PORTSC_LINE_STATUS_UNDEF (0x3<<10)
|
|
#define PORTSC_LINE_STATUS_BIT_POS (10)
|
|
|
|
/* bit 15-14 are port indicator control */
|
|
#define PORTSC_PIC_OFF (0x0<<14)
|
|
#define PORTSC_PIC_AMBER (0x1<<14)
|
|
#define PORTSC_PIC_GREEN (0x2<<14)
|
|
#define PORTSC_PIC_UNDEF (0x3<<14)
|
|
#define PORTSC_PIC_BIT_POS (14)
|
|
|
|
/* bit 19-16 are port test control */
|
|
#define PORTSC_PTC_DISABLE (0x0<<16)
|
|
#define PORTSC_PTC_JSTATE (0x1<<16)
|
|
#define PORTSC_PTC_KSTATE (0x2<<16)
|
|
#define PORTSC_PTC_SEQNAK (0x3<<16)
|
|
#define PORTSC_PTC_PACKET (0x4<<16)
|
|
#define PORTSC_PTC_FORCE_EN (0x5<<16)
|
|
#define PORTSC_PTC_BIT_POS (16)
|
|
|
|
/* bit 27-26 are port speed */
|
|
#define PORTSC_PORT_SPEED_FULL (0x0<<26)
|
|
#define PORTSC_PORT_SPEED_LOW (0x1<<26)
|
|
#define PORTSC_PORT_SPEED_HIGH (0x2<<26)
|
|
#define PORTSC_PORT_SPEED_UNDEF (0x3<<26)
|
|
#define PORTSC_SPEED_BIT_POS (26)
|
|
|
|
/* bit 28 is parallel transceiver width for UTMI interface */
|
|
#define PORTSC_PTW (0x1<<28)
|
|
#define PORTSC_PTW_8BIT (0x0<<28)
|
|
#define PORTSC_PTW_16BIT (0x1<<28)
|
|
|
|
/* bit 31-30 are port transceiver select */
|
|
#define PORTSC_PTS_UTMI (0x0<<30)
|
|
#define PORTSC_PTS_ULPI (0x2<<30)
|
|
#define PORTSC_PTS_FSLS_SERIAL (0x3<<30)
|
|
#define PORTSC_PTS_BIT_POS (30)
|
|
|
|
#define PORTSC_W1C_BITS \
|
|
(PORTSC_CONNECT_STATUS_CHANGE | \
|
|
PORTSC_PORT_EN_DIS_CHANGE | \
|
|
PORTSC_OVER_CUURENT_CHG)
|
|
|
|
/* OTG Status Control Register Bit Masks */
|
|
#define OTGSC_CTRL_VBUS_DISCHARGE (0x1<<0)
|
|
#define OTGSC_CTRL_VBUS_CHARGE (0x1<<1)
|
|
#define OTGSC_CTRL_OTG_TERMINATION (0x1<<3)
|
|
#define OTGSC_CTRL_DATA_PULSING (0x1<<4)
|
|
#define OTGSC_CTRL_ID_PULL_EN (0x1<<5)
|
|
#define OTGSC_HA_DATA_PULSE (0x1<<6)
|
|
#define OTGSC_HA_BA (0x1<<7)
|
|
#define OTGSC_STS_USB_ID (0x1<<8)
|
|
#define OTGSC_STS_A_VBUS_VALID (0x1<<9)
|
|
#define OTGSC_STS_A_SESSION_VALID (0x1<<10)
|
|
#define OTGSC_STS_B_SESSION_VALID (0x1<<11)
|
|
#define OTGSC_STS_B_SESSION_END (0x1<<12)
|
|
#define OTGSC_STS_1MS_TOGGLE (0x1<<13)
|
|
#define OTGSC_STS_DATA_PULSING (0x1<<14)
|
|
#define OTGSC_INTSTS_USB_ID (0x1<<16)
|
|
#define OTGSC_INTSTS_A_VBUS_VALID (0x1<<17)
|
|
#define OTGSC_INTSTS_A_SESSION_VALID (0x1<<18)
|
|
#define OTGSC_INTSTS_B_SESSION_VALID (0x1<<19)
|
|
#define OTGSC_INTSTS_B_SESSION_END (0x1<<20)
|
|
#define OTGSC_INTSTS_1MS (0x1<<21)
|
|
#define OTGSC_INTSTS_DATA_PULSING (0x1<<22)
|
|
#define OTGSC_INTR_USB_ID_EN (0x1<<24)
|
|
#define OTGSC_INTR_A_VBUS_VALID_EN (0x1<<25)
|
|
#define OTGSC_INTR_A_SESSION_VALID_EN (0x1<<26)
|
|
#define OTGSC_INTR_B_SESSION_VALID_EN (0x1<<27)
|
|
#define OTGSC_INTR_B_SESSION_END_EN (0x1<<28)
|
|
#define OTGSC_INTR_1MS_TIMER_EN (0x1<<29)
|
|
#define OTGSC_INTR_DATA_PULSING_EN (0x1<<30)
|
|
#define OTGSC_INTSTS_MASK (0x00ff0000)
|
|
|
|
/* USB MODE Register Bit Masks */
|
|
#define USB_MODE_CTRL_MODE_IDLE (0x0<<0)
|
|
#define USB_MODE_CTRL_MODE_DEVICE (0x2<<0)
|
|
#define USB_MODE_CTRL_MODE_HOST (0x3<<0)
|
|
#define USB_MODE_CTRL_MODE_RSV (0x1<<0)
|
|
#define USB_MODE_SETUP_LOCK_OFF (0x1<<3)
|
|
#define USB_MODE_STREAM_DISABLE (0x1<<4)
|
|
#define USB_MODE_ES (0x1<<2) /* Endian Select */
|
|
|
|
/* control Register Bit Masks */
|
|
#define USB_CTRL_IOENB (0x1<<2)
|
|
#define USB_CTRL_ULPI_INT0EN (0x1<<0)
|
|
|
|
/* BCSR5 */
|
|
#define BCSR5_INT_USB (0x02)
|
|
|
|
/* USB module clk cfg */
|
|
#define SCCR_OFFS (0xA08)
|
|
#define SCCR_USB_CLK_DISABLE (0x00000000) /* USB clk disable */
|
|
#define SCCR_USB_MPHCM_11 (0x00c00000)
|
|
#define SCCR_USB_MPHCM_01 (0x00400000)
|
|
#define SCCR_USB_MPHCM_10 (0x00800000)
|
|
#define SCCR_USB_DRCM_11 (0x00300000)
|
|
#define SCCR_USB_DRCM_01 (0x00100000)
|
|
#define SCCR_USB_DRCM_10 (0x00200000)
|
|
|
|
#define SICRL_OFFS (0x114)
|
|
#define SICRL_USB0 (0x40000000)
|
|
#define SICRL_USB1 (0x20000000)
|
|
|
|
#define SICRH_OFFS (0x118)
|
|
#define SICRH_USB_UTMI (0x00020000)
|
|
|
|
/* OTG interrupt enable bit masks */
|
|
#define OTGSC_INTERRUPT_ENABLE_BITS_MASK \
|
|
(OTGSC_INTR_USB_ID_EN | \
|
|
OTGSC_INTR_1MS_TIMER_EN | \
|
|
OTGSC_INTR_A_VBUS_VALID_EN | \
|
|
OTGSC_INTR_A_SESSION_VALID_EN | \
|
|
OTGSC_INTR_B_SESSION_VALID_EN | \
|
|
OTGSC_INTR_B_SESSION_END_EN | \
|
|
OTGSC_INTR_DATA_PULSING_EN)
|
|
|
|
/* OTG interrupt status bit masks */
|
|
#define OTGSC_INTERRUPT_STATUS_BITS_MASK \
|
|
(OTGSC_INTSTS_USB_ID | \
|
|
OTGSC_INTR_1MS_TIMER_EN | \
|
|
OTGSC_INTSTS_A_VBUS_VALID | \
|
|
OTGSC_INTSTS_A_SESSION_VALID | \
|
|
OTGSC_INTSTS_B_SESSION_VALID | \
|
|
OTGSC_INTSTS_B_SESSION_END | \
|
|
OTGSC_INTSTS_DATA_PULSING)
|
|
|
|
/*
|
|
* A-DEVICE timing constants
|
|
*/
|
|
|
|
/* Wait for VBUS Rise */
|
|
#define TA_WAIT_VRISE (100) /* a_wait_vrise 100 ms, section: 6.6.5.1 */
|
|
|
|
/* Wait for B-Connect */
|
|
#define TA_WAIT_BCON (10000) /* a_wait_bcon > 1 sec, section: 6.6.5.2
|
|
* This is only used to get out of
|
|
* OTG_STATE_A_WAIT_BCON state if there was
|
|
* no connection for these many milliseconds
|
|
*/
|
|
|
|
/* A-Idle to B-Disconnect */
|
|
/* It is necessary for this timer to be more than 750 ms because of a bug in OPT
|
|
* test 5.4 in which B OPT disconnects after 750 ms instead of 75ms as stated
|
|
* in the test description
|
|
*/
|
|
#define TA_AIDL_BDIS (5000) /* a_suspend minimum 200 ms, section: 6.6.5.3 */
|
|
|
|
/* B-Idle to A-Disconnect */
|
|
#define TA_BIDL_ADIS (12) /* 3 to 200 ms */
|
|
|
|
/* B-device timing constants */
|
|
|
|
|
|
/* Data-Line Pulse Time*/
|
|
#define TB_DATA_PLS (10) /* b_srp_init,continue 5~10ms, section:5.3.3 */
|
|
#define TB_DATA_PLS_MIN (5) /* minimum 5 ms */
|
|
#define TB_DATA_PLS_MAX (10) /* maximum 10 ms */
|
|
|
|
/* SRP Initiate Time */
|
|
#define TB_SRP_INIT (100) /* b_srp_init,maximum 100 ms, section:5.3.8 */
|
|
|
|
/* SRP Fail Time */
|
|
#define TB_SRP_FAIL (7000) /* b_srp_init,Fail time 5~30s, section:6.8.2.2*/
|
|
|
|
/* SRP result wait time */
|
|
#define TB_SRP_WAIT (60)
|
|
|
|
/* VBus time */
|
|
#define TB_VBUS_PLS (30) /* time to keep vbus pulsing asserted */
|
|
|
|
/* Discharge time */
|
|
/* This time should be less than 10ms. It varies from system to system. */
|
|
#define TB_VBUS_DSCHRG (8)
|
|
|
|
/* A-SE0 to B-Reset */
|
|
#define TB_ASE0_BRST (20) /* b_wait_acon, mini 3.125 ms,section:6.8.2.4 */
|
|
|
|
/* A bus suspend timer before we can switch to b_wait_aconn */
|
|
#define TB_A_SUSPEND (7)
|
|
#define TB_BUS_RESUME (12)
|
|
|
|
/* SE0 Time Before SRP */
|
|
#define TB_SE0_SRP (2) /* b_idle,minimum 2 ms, section:5.3.2 */
|
|
|
|
#define SET_OTG_STATE(otg_ptr, newstate) ((otg_ptr)->state = newstate)
|
|
|
|
struct usb_dr_mmap {
|
|
/* Capability register */
|
|
u8 res1[256];
|
|
u16 caplength; /* Capability Register Length */
|
|
u16 hciversion; /* Host Controller Interface Version */
|
|
u32 hcsparams; /* Host Controller Structual Parameters */
|
|
u32 hccparams; /* Host Controller Capability Parameters */
|
|
u8 res2[20];
|
|
u32 dciversion; /* Device Controller Interface Version */
|
|
u32 dccparams; /* Device Controller Capability Parameters */
|
|
u8 res3[24];
|
|
/* Operation register */
|
|
u32 usbcmd; /* USB Command Register */
|
|
u32 usbsts; /* USB Status Register */
|
|
u32 usbintr; /* USB Interrupt Enable Register */
|
|
u32 frindex; /* Frame Index Register */
|
|
u8 res4[4];
|
|
u32 deviceaddr; /* Device Address */
|
|
u32 endpointlistaddr; /* Endpoint List Address Register */
|
|
u8 res5[4];
|
|
u32 burstsize; /* Master Interface Data Burst Size Register */
|
|
u32 txttfilltuning; /* Transmit FIFO Tuning Controls Register */
|
|
u8 res6[8];
|
|
u32 ulpiview; /* ULPI register access */
|
|
u8 res7[12];
|
|
u32 configflag; /* Configure Flag Register */
|
|
u32 portsc; /* Port 1 Status and Control Register */
|
|
u8 res8[28];
|
|
u32 otgsc; /* On-The-Go Status and Control */
|
|
u32 usbmode; /* USB Mode Register */
|
|
u32 endptsetupstat; /* Endpoint Setup Status Register */
|
|
u32 endpointprime; /* Endpoint Initialization Register */
|
|
u32 endptflush; /* Endpoint Flush Register */
|
|
u32 endptstatus; /* Endpoint Status Register */
|
|
u32 endptcomplete; /* Endpoint Complete Register */
|
|
u32 endptctrl[6]; /* Endpoint Control Registers */
|
|
u8 res9[552];
|
|
u32 snoop1;
|
|
u32 snoop2;
|
|
u32 age_cnt_thresh; /* Age Count Threshold Register */
|
|
u32 pri_ctrl; /* Priority Control Register */
|
|
u32 si_ctrl; /* System Interface Control Register */
|
|
u8 res10[236];
|
|
u32 control; /* General Purpose Control Register */
|
|
};
|
|
|
|
struct fsl_otg_timer {
|
|
unsigned long expires; /* Number of count increase to timeout */
|
|
unsigned long count; /* Tick counter */
|
|
void (*function)(unsigned long); /* Timeout function */
|
|
unsigned long data; /* Data passed to function */
|
|
struct list_head list;
|
|
};
|
|
|
|
inline struct fsl_otg_timer *otg_timer_initializer
|
|
(void (*function)(unsigned long), unsigned long expires, unsigned long data)
|
|
{
|
|
struct fsl_otg_timer *timer;
|
|
|
|
timer = kmalloc(sizeof(struct fsl_otg_timer), GFP_KERNEL);
|
|
if (!timer)
|
|
return NULL;
|
|
timer->function = function;
|
|
timer->expires = expires;
|
|
timer->data = data;
|
|
return timer;
|
|
}
|
|
|
|
struct fsl_otg {
|
|
struct usb_phy phy;
|
|
struct otg_fsm fsm;
|
|
struct usb_dr_mmap *dr_mem_map;
|
|
struct delayed_work otg_event;
|
|
|
|
/* used for usb host */
|
|
struct work_struct work_wq;
|
|
u8 host_working;
|
|
|
|
int irq;
|
|
};
|
|
|
|
struct fsl_otg_config {
|
|
u8 otg_port;
|
|
};
|
|
|
|
/* For SRP and HNP handle */
|
|
#define FSL_OTG_MAJOR 240
|
|
#define FSL_OTG_NAME "fsl-usb2-otg"
|
|
/* Command to OTG driver ioctl */
|
|
#define OTG_IOCTL_MAGIC FSL_OTG_MAJOR
|
|
/* if otg work as host, it should return 1, otherwise return 0 */
|
|
#define GET_OTG_STATUS _IOR(OTG_IOCTL_MAGIC, 1, int)
|
|
#define SET_A_SUSPEND_REQ _IOW(OTG_IOCTL_MAGIC, 2, int)
|
|
#define SET_A_BUS_DROP _IOW(OTG_IOCTL_MAGIC, 3, int)
|
|
#define SET_A_BUS_REQ _IOW(OTG_IOCTL_MAGIC, 4, int)
|
|
#define SET_B_BUS_REQ _IOW(OTG_IOCTL_MAGIC, 5, int)
|
|
#define GET_A_SUSPEND_REQ _IOR(OTG_IOCTL_MAGIC, 6, int)
|
|
#define GET_A_BUS_DROP _IOR(OTG_IOCTL_MAGIC, 7, int)
|
|
#define GET_A_BUS_REQ _IOR(OTG_IOCTL_MAGIC, 8, int)
|
|
#define GET_B_BUS_REQ _IOR(OTG_IOCTL_MAGIC, 9, int)
|
|
|
|
void fsl_otg_add_timer(struct otg_fsm *fsm, void *timer);
|
|
void fsl_otg_del_timer(struct otg_fsm *fsm, void *timer);
|
|
void fsl_otg_pulse_vbus(void);
|