usbacm_drv.c

MTK平台绝密核心代码之 USB驱动

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *    usbacm_drv.c
 *
 * Project:
 * --------
 *   Maui_Software
 *
 * Description:
 * ------------
 *   This file implements usb CDC ACM class driver
 *
 * Author:
 * -------
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/
 
#include "stack_common.h"
#include 	"stack_msgs.h"
#include "drv_comm.h"
#include "gpt_sw.h"

#include "usb_comm.h"
#include "usb_drv.h"
#include "usb.h"
#include "usb_resource.h"
#include "usbacm_drv.h"
#include "usbacm_adap.h"
#include "usb_custom.h"

/* global variables */
UARTStruct USB2UARTPort;
UsbAcm_Struct g_UsbACM;


/* for DMA tx buffer and tx_isr buffer to differentiate */
static USBTRX_MEM_TYPE USB2Uart_MemType;
static kal_uint32  USB2Uart_WriteLength;

/* static functions */
static kal_uint32 USB2UART_Check_Transmit_Data(kal_uint32* addr);
static void USB2UART_Update_Transmit_Data(void);
static void USB2UART_Tx_DMA_Callback(void);
static void USB_Acm_Break_Timeout(void *parameter);
static void USB_Acm_Ep0_SetLineCoding(void *data);
static void USB_Acm_Ep0_Command(Usb_Ep0_Status* pep0state,Usb_Command* pcmd);
static void USB_Acm_BulkOut_Hdr(void);
static void USB_Acm_BulkIn_Reset(void);
static void USB_Acm_BulkOut_Reset(void);

static void USB_Acm_FT_BulkOut_Hdr(void );


/*************************************************************
  translate ACM and UART setting functions
**************************************************************/

/* translate ACM line coding to UART DCB */
void USB2UART_LineCoding2DCB(UsbAcm_Line_Coding *pline_coding, UARTDCBStruct *pDCB)
{
	 pDCB->baud = pline_coding->dwDTERate;
	 pDCB->stopBits = pline_coding->bCharFormat+1; 
	 pDCB->parity = pline_coding->bParityType;
	 pDCB->dataBits = pline_coding->bDataBits;
}

/* translate UART DCB to ACM line coding */
void UART2USB_DCB2LineCoding(UARTDCBStruct *pDCB, UsbAcm_Line_Coding *pline_coding)
{
	  pline_coding->dwDTERate = pDCB->baud;
	  pline_coding->bCharFormat = pDCB->stopBits-1;
	  pline_coding->bParityType = pDCB->parity;
	  pline_coding->bDataBits = pDCB->dataBits;
}

/************************************************************
	GPT timeout handle escape character detect
*************************************************************/

/* GPT timer handler for Escape character detect */
void USB2UART_Timeout(void *parameter)
{
	UARTStruct *UARTData=(UARTStruct *)parameter;
	GPTI_StopItem(UARTData->handle);

	switch(UARTData->Rec_state)
	{
	case UART_Get3EscChar:
		/* escape detect */
		UARTData->EscFound = KAL_TRUE;
		UARTData->Rec_state = UART_RecNormal;
		UARTData->EscCount = 0;
		USB2UART_Sendilm(MSG_ID_UART_ESCAPE_DETECTED_IND);
		break;
	case UART_RecNormal:
		/* first timeout, start to check escape character */
		UARTData->Rec_state = UART_StartCheckESC;
		UARTData->EscCount = 0;
		break;
	case UART_StartCheckESC:
		UARTData->Rec_state = UART_RecNormal;
		UARTData->EscCount = 0;
		break;
	}
}

/************************************************************
	Default UART callback function. Send ilm to UART owner
*************************************************************/

void USB2UART_Dafault_Tx_Callback(UART_PORT port)
{
	if (g_UsbACM.send_Txilm)
	{
		/* send message to UART owner*/
		USB2UART_Sendilm(MSG_ID_UART_READY_TO_WRITE_IND);
		g_UsbACM.send_Txilm = KAL_FALSE;
		g_UsbACM.config_send_Txilm = KAL_FALSE;
	}   
}

void USB2UART_Dafault_Rx_Callback(UART_PORT port)
{
	if (g_UsbACM.send_Rxilm)
	{
		/* send ready to read message to UART onwer if needed*/
		USB2UART_Sendilm(MSG_ID_UART_READY_TO_READ_IND);
		g_UsbACM.send_Rxilm = KAL_FALSE;
	} 
}

/************************************************************
	Bulk EP IN handle functions (DMA setup and callback functions)
*************************************************************/

/* 
    Determine transmit data
    If return value is large than 0, the caller should send the data in parameter.
     This function and "USB2UART_Update_Transmit_Data" function must be pair.
*/
static kal_uint32 USB2UART_Check_Transmit_Data(kal_uint32* addr)
{
	kal_uint32 length=0;
	
	/* check if TX ISR buffer has data to send out first */
	if (USB2UARTPort.Tx_Buffer_ISR.Write != USB2UARTPort.Tx_Buffer_ISR.Read)
	{
		/* used for callback function to know sent source */
		USB2Uart_MemType = USBTRX_MEM_ISR;
		*addr = (kal_uint32)USB2UARTPort.Tx_Buffer_ISR.CharBuffer+USB2UARTPort.Tx_Buffer_ISR.Read;
		if (USB2UARTPort.Tx_Buffer_ISR.Write >= USB2UARTPort.Tx_Buffer_ISR.Read)
		{
			length = USB2UARTPort.Tx_Buffer_ISR.Write - USB2UARTPort.Tx_Buffer_ISR.Read;
		}
		else
		{
			length = USB2UARTPort.Tx_Buffer_ISR.Length - USB2UARTPort.Tx_Buffer_ISR.Read;
		}
	}
	/* later check if TX buffer has data to send out */
	else if (USB2UARTPort.Tx_Buffer.Write != USB2UARTPort.Tx_Buffer.Read)
	{
		/* used for callback function to know sent source */
		USB2Uart_MemType = USBTRX_MEM_TASK;
		*addr = (kal_uint32)USB2UARTPort.Tx_Buffer.CharBuffer+USB2UARTPort.Tx_Buffer.Read;
		if (USB2UARTPort.Tx_Buffer.Write >= USB2UARTPort.Tx_Buffer.Read)
		{		
			length = USB2UARTPort.Tx_Buffer.Write - USB2UARTPort.Tx_Buffer.Read;
		}
		else
		{
			length = USB2UARTPort.Tx_Buffer.Length - USB2UARTPort.Tx_Buffer.Read;
		}
	}

	/* If the packet size is multiple of 64, make the last one to be less than 64.
	   Otherwise the last packet may not be seen on WinXP */
	if(((length& 0x3f)==0) && (length!=0))
		USB2Uart_WriteLength = length - 1;
	else	
		USB2Uart_WriteLength = length;
	
	return USB2Uart_WriteLength;
}

/* 
    Update the buffer information after transmit done
    Note that "USB2Uart_WriteLength" will be reset to 0.
    This function and "USB2UART_Check_Transmit_Data" function must be pair.
*/
static void USB2UART_Update_Transmit_Data(void)
{
	/* update buffer information */
	if (USB2Uart_MemType == USBTRX_MEM_ISR)
	{
		USB2UARTPort.Tx_Buffer_ISR.Read += USB2Uart_WriteLength;
		ASSERT(USB2UARTPort.Tx_Buffer_ISR.Read <= USB2UARTPort.Tx_Buffer_ISR.Length);
		if (USB2UARTPort.Tx_Buffer_ISR.Read == USB2UARTPort.Tx_Buffer_ISR.Length)