hal4rbc.h

smartARM2400 USB OTG例程

/****************************************Copyright (c)****************************************************
**                            Guangzhou ZHIYUAN electronics Co.,LTD.
**                                      
**                                 http://www.embedtools.com
**
**--------------File Info---------------------------------------------------------------------------------
** File name:               Hal4Rbc.h
** Latest modified Date:    2007-10-12
** Latest Version:          1.0
** Descriptions:            本文件包含了USB大容量类软件包与具体USB器件的接口定义
                            主要有：1)批量端点相关定义;2)批量传输所需要的USB底层支
                            持函数。
**
**--------------------------------------------------------------------------------------------------------
** Created by:              Lizhenming
** Created date:            2007-09-18
** Version:                 1.0
** Descriptions:            The original version
**
*********************************************************************************************************/

#ifndef     __HAL4RBC_H
#define     __HAL4RBC_H

#define     __BULKEP_RW_ERR           0xffff                            /*  批量端点读写不正常          */   
/*********************************************************************************************************
   批量端点相关定义                                                                                  
*********************************************************************************************************/
/*
 *  批量端点读写函数一次读写的最大字节数(不一定是物理端点的最大数据包大小)，不能大于存储器扇区大小
 */
#define     __BULK_PACKET_SIZE      512

/*********************************************************************************************************
   批量传输所需要的USB底层支持函数(读写端点、设置端点状态等），注意这些操作要在关中断下进行                                                                                
*********************************************************************************************************/
/*********************************************************************************************************
** Function name:           __tpbulkRead
**
** Descriptions:            读取批量输出端点数据,不能正常读出数据时返回__BULKEP_RW_ERR（如端点缓冲区空，
**                          端点停止等)
** input parameters:        __uint16  len    要读取的数据长度
**                          __uint8 *buf     接收数据指针    
** output parameters:       无
** Returned value:          实际读得的字节数，或__BULKEP_RW_ERR                                                               
**                          
*********************************************************************************************************/
__uint16     __bulkRead (__uint16 len, __uint8 *buf);


/*********************************************************************************************************
** Function name:           __tpbulkWrite
**
** Descriptions:            从批量输入端点发送数据，不能正常发送数据时返回__BULKEP_RW_ERR（如端点缓冲区满，
**                          端点停止等)
** input parameters:        __uint16  len     要写入的数据长度
**                          __uint8  *buf     发送数据指针    
** output parameters:       无
** Returned value:          实际发送的字节数，或__BULKEP_RW_ERR                                                              
**                          
*********************************************************************************************************/
__uint16     __bulkWrite (__uint16 len, __uint8 *buf);

/*********************************************************************************************************
** Function name:           __single_transmit
**
** Descriptions:            通过控制端点0发送单包数据
**
** input parameters:        __uint8  len     要写入的数据长度(len 小于控制端点0最大数据包大小)
**                          __uint8 *buf     发送数据指针    
** output parameters:       无
** Returned value:          实际发送的字节数                                                        
**                          
*********************************************************************************************************/
__uint8    __singleTransmit (__uint8 *buf, __uint8 len);

/*********************************************************************************************************
** Function name:           __BIEPStall
**
** Descriptions:            停止批量输入端点
**
** input parameters:        无                       
** output parameters:       无
** Returned value:          无                                                                              
*********************************************************************************************************/                                                                      
void    __BIEPStall (void);
/*********************************************************************************************************
** Function name:           __BOEPStall
**
** Descriptions:            停止批量输出端点
**
** input parameters:        无                       
** output parameters:       无
** Returned value:          无                                                                              
*********************************************************************************************************/  
void    __BOEPStall (void);


#endif