/****************************************Copyright (c)**************************************************
**                               CH374做主機操作U盤讀寫程序
**                                   Bulk-only傳輸協議層
**                                        頭文件
**
**                                        VBeat 0.2
**
**--------------文件信息--------------------------------------------------------------------------------
**文   件   名: Bulkonly.H
**創   建   人: 徐亦朱
**最后修改日期: 2007年9月25日
**描        述: Bulk-only傳輸協議層頭文件
**              
**--------------歷史版本信息----------------------------------------------------------------------------
** 創建人: 徐亦朱
** 版  本: VBeat 0.1
** 日　期: 2007年9月21日
** 描　述: 原始版本
**
**--------------當前版本修訂------------------------------------------------------------------------------
** 修改人: 徐亦朱
** 日　期: 2007年9月25日
** 描　述: 優化頭文件
**
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/

//Bulk-only Transport請求
static const UINT8C  BoResetUsbDisk   [ ] = { 0x21, 0xFF, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } ; //Bulk_Only_Mass_Storage_Reset
static const UINT8C  Get_Max_Lun      [ ] = { 0xA1, 0xFE, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00 } ; //Get_Max_Lun

//命令塊CBW識別標志 dCBWSignature
#define  USB_BO_CBW_SIG  0x55534243
//命令狀態塊CSW識別標志 dCSWSignature
#define  USB_BO_CSW_SIG  0x55534253
//命令塊CBW的總長度
#define  USB_BO_CBW_SIZE  0x1F
//命令狀態塊CSW的總長度
#define  USB_BO_CSW_SIZE  0x0D

//Bulk-only的CBW，CSW結構
typedef union  _BULK_ONLY_CMD
{
     struct
     {
          UINT32 mCBW_Sig;              //dCBWSignature               CBW標志區
          UINT32 mCBW_Tag;              //dCBWTag                     
          UINT32 mCBW_DataLen;          //dCBWDataTransferLength      主機和設備之間傳送的數據字節數
          UINT8  mCBW_Flag;             //bmCBWFlag                   傳輸方向等標志
          UINT8  mCBW_LUN;              //bCBWLUN                     一般為0
          UINT8  mCBW_CB_Len;           //bCBWCBLength                CBW命令的長度，有效值：1 -- 16
          UINT8  mCBW_CB_BUF[ 16 ];     //CBWCB                       命令
     } mCBW;
     
     struct
     {
          UINT32 mCSW_Sig;              //dCSWSignature               CSW標志區
          UINT32 mCSW_Tag;              //dCSWTag       
          UINT32 mCSW_Residue;          //dCSWDataResidue             還需要傳送的數據
          UINT8  mCSW_Status;           //bCSWStatus                  返回0即可
     } mCSW;

} BULK_ONLY_CMD;

//  定義Bulk-only傳輸結構
static BULK_ONLY_CMD idata  mBOC; 

/*********************************************************************************************************
** 函數名稱: IsDiskConnect
** 功能描述: 檢查磁盤是否連接
**
** 輸　入: 
** 輸　出: USB_INT_SUCCESS:    已經連接
**         USB_INT_CONNECT:    剛連接
**         USB_INT_DISCONNECT: 斷開
**         
** 全局變量: 無
** 調用模塊: 無
** 調試碼:   無
**  
**
** 作　者: 徐亦朱
** 日　期: 2007年9月21日
**-------------------------------------------------------------------------------------------------------
** 修改人: 
** 日　期: 
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
static UINT8  IsDiskConnect( void ) ;

/*********************************************************************************************************
** 函數名稱: mResetErrorBOC
** 功能描述: USB DISK重置
**
** 輸　入: LastError: 重置前的錯誤碼
** 輸　出: 
**         
** 全局變量: 無
** 調用模塊: 無
** 調試碼:   無
**  
**
** 作　者: 徐亦朱
** 日　期: 2007年9月21日
**-------------------------------------------------------------------------------------------------------
** 修改人: 
** 日　期: 
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
static UINT8  mResetErrorBOC( UINT8 LastError ) ;

/*********************************************************************************************************
** 函數名稱: mBulkOnlyCmd
** 功能描述: 執行基于Bulk-only協議的命令
**
** 輸　入: DataBuf: 指向數據緩沖區
** 輸　出: 
**         
** 全局變量: 無
** 調用模塊: 無
** 調試碼:   無
**  
**
** 作　者: 徐亦朱
** 日　期: 2007年9月21日
**-------------------------------------------------------------------------------------------------------
** 修改人: 
** 日　期: 
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
static UINT8  mBulkOnlyCmd( PUINT8 DataBuf ) ;

/*********************************************************************************************************
** 函數名稱: mDiskInquiry
** 功能描述: 獲取磁盤特性
**
** 輸　入: DataBuf: 指向數據緩沖區
** 輸　出: 
**         
** 全局變量: 無
** 調用模塊: mBulkOnlyCmd
** 調試碼:   無
**  
**
** 作　者: 徐亦朱
** 日　期: 2007年9月24日
**-------------------------------------------------------------------------------------------------------
** 修改人: 
** 日　期: 
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
UINT8  mDiskInquiry( PUINT8 DataBuf ) ;

/*********************************************************************************************************
** 函數名稱: Read Capacity
** 功能描述: 獲取磁盤容量
**
** 輸　入: DataBuf: 指向數據緩沖區
** 輸　出: 要求設備返回當前容量
**         
** 全局變量: 無
** 調用模塊: mBulkOnlyCmd
** 調試碼:   無
**  
**
** 作　者: 徐亦朱
** 日　期: 2007年9月24日
**-------------------------------------------------------------------------------------------------------
** 修改人: 
** 日　期: 
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
UINT8  mDiskCapacity( PUINT8 DataBuf ) ;

/*********************************************************************************************************
** 函數名稱: Test Unit Ready
** 功能描述: 測試磁盤是否就緒
**
** 輸　入: DataBuf: 指向數據緩沖區
** 輸　出: 請求設備報告是否處于Ready狀態
**         
** 全局變量: 無
** 調用模塊: mBulkOnlyCmd
** 調試碼:   無
**  
**
** 作　者: 徐亦朱
** 日　期: 2007年9月24日
**-------------------------------------------------------------------------------------------------------
** 修改人: 
** 日　期: 
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
UINT8  mDiskTestReady( void ) ;

/*********************************************************************************************************
** 函數名稱: Request Sense
** 功能描述: 檢查磁盤錯誤狀態
**
** 輸　入: DataBuf: 指向數據緩沖區
** 輸　出: 請求設備向主機返回執行結果
**         
** 全局變量: 無
** 調用模塊: mBulkOnlyCmd
** 調試碼:   無
**  
**
** 作　者: 徐亦朱
** 日　期: 2007年9月24日
**-------------------------------------------------------------------------------------------------------
** 修改人: 
** 日　期: 
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
UINT8  mRequestSense( void ) ;

/*********************************************************************************************************
** 函數名稱: mReadSector  Read( 10 )
** 功能描述: 以扇區為單位從磁盤讀取數據
**
** 輸　入: StartLba:  操作的起始扇區號
**         SectCount: 扇區數量
**         DataBuf:   指向數據緩沖區  
** 輸　出: 請求設備向主機返回執行結果
**         
** 全局變量: 無
** 調用模塊: mBulkOnlyCmd
** 調試碼:   無
**  
**
** 作　者: 徐亦朱
** 日　期: 2007年9月24日
**-------------------------------------------------------------------------------------------------------
** 修改人: 
** 日　期: 
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
UINT8  mReadSector( UINT32 StartLba, UINT8 SectCount, PUINT8 DataBuf ) ;

/*********************************************************************************************************
** 函數名稱: mWriteSector Write( 10 )
** 功能描述: 以扇區為單位將數據寫入磁盤
**
** 輸　入: StartLba:  操作的起始扇區號
**         SectCount: 扇區數量
**         DataBuf:   指向數據緩沖區  
** 輸　出: 請求設備向主機返回執行結果
**         
** 全局變量: 無
** 調用模塊: mBulkOnlyCmd
** 調試碼:   無
**  
**
** 作　者: 徐亦朱
** 日　期: 2007年9月24日
**-------------------------------------------------------------------------------------------------------
** 修改人: 
** 日　期: 
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/
UINT8  mWriteSector( UINT32 StartLba, UINT8 SectCount, PUINT8 DataBuf ) ;

/*********************************************************************************************************
**
**                                 引用變量及函數聲明
**
**------------------------------------------------------------------------------------------------------
********************************************************************************************************/

extern UINT8  mSaveDevEndpTog ;
extern UINT8  mDiskBulkInEndp ;
extern UINT8  mDiskBulkOutEndp ;
extern UINT8  mDiskInterfNumber ;

extern void  SetHostUsbAddr ( UINT8 addr );
extern void  HostSetBusFree( void );
extern UINT8  HostCtrlTransfer374( PUINT8 ReqBuf, PUINT8 DatBuf, PUINT8 RetLen );
extern UINT8  mClearEndpStall( UINT8 endp );  
extern void  mSetBulkIn( void ) ;
extern void  mSetBulkOut( void ) ;
extern UINT8  HostTransactInter( void ) ;

/*********************************************************************************************************
**                            End Of File
********************************************************************************************************/