tkusbhost.h

説明を見る。

/*******************************************************************************
* RXduinoライブラリ & 特電HAL
* 
* このソフトウェアは特殊電子回路株式会社によって開発されたものです。
* 当社Webサイトを通じてダウンロードすることによって使用許諾されます。
* このファイルを第三者へ開示・再配布・貸与・譲渡することはできません。
* このソフトウェアはあるがままの状態で提供され、内容および動作についての保障はあ
* りません。弊社はファイルの内容および実行結果についていかなる責任も負いません。
* お客様は、お客様の製品開発のために当ソフトウェアのソースコードを自由に参照し、
* 引用していただくことができます。
* コンパイル・リンク後のオブジェクトファイル(ELF ファイルまたはMOT,SRECファイル)
* であって、デバッグ情報が削除されている場合は第三者に再配布することができます。
* (C) Copyright 2011-2014 TokushuDenshiKairo Inc. 特殊電子回路株式会社
* http://rx.tokudenkairo.co.jp/
*******************************************************************************/

#ifndef TKUSBHOST_H
#define TKUSBHOST_H
/**************************************************************************/
#define TIMEOUT         1000  //1000ms
#define TIMEOUT_INFINITE -1

#define DEVICE_DESCRIPTOR_TYPE    0x01
#define CONFIG_DESCRIPTOR_TYPE    0x02
#define STRING_DESCRIPTOR_TYPE    0x03
#define INTERFACE_DESCRIPTOR_TYPE 0x04
#define ENDPOINT_DESCRIPTOR_TYPE  0x05

#ifdef __cplusplus
extern "C" {
#endif

typedef struct DeviceDesc_t
{
    unsigned char  bLength;
    unsigned char  bDescriptorType;
    unsigned short bcdUSB;
    unsigned char  bDeviceClass;
    unsigned char  bDeviceSubClass;
    unsigned char  bDeviceProtocol;
    unsigned char  bMaxPacketSize0;
    unsigned short idVendor;
    unsigned short idProduct;
    unsigned short bcdDevice;
    unsigned char  iManufacture;
    unsigned char  iProduct;
    unsigned char  iSerialNumber;
    unsigned char  bNumConfigurations;
} DeviceDesc_t;

typedef struct ConfigDesc_t
{
    unsigned char  bLength;
    unsigned char  bDescriptorType;
    unsigned short wTotalLength;
    unsigned char  bNumInterfaces;
    unsigned char  bConfigurationValue;
    unsigned char  iConfiguraion;
    unsigned char  bmAttributes;
    unsigned char  bMaxPower;
} ConfigDesc_t;

typedef struct EndpointDesc_t
{
    unsigned char  bLength;
    unsigned char  bDescriptorType;
    unsigned char  bEndpointAddress;
    unsigned char  bmAttributes;
    unsigned short wMaxPacketSize;
    unsigned char  bInterval;
    unsigned char  bRefresh;
    unsigned char  bSynchAddress;
} EndpointDesc_t;

typedef struct InterfaceDesc_t
{
    unsigned char  bLength;
    unsigned char  bDescriptorType;
    unsigned char  bInterfaceNumber;
    unsigned char  bAlternateSetting;
    unsigned char  bNumEndpoints;
    unsigned char  bInterfaceClass;
    unsigned char  bInterfaceSubClass;
    unsigned char  bInterfaceProtocol;
    unsigned char  iInterface;
} InterfaceDesc_t;

typedef struct USBHostInfo_t
{
    DeviceDesc_t    DeviceDesc;    
    ConfigDesc_t    ConfigDesc;    
    EndpointDesc_t  EndpointDesc;  
    InterfaceDesc_t InterfaceDesc; 
    unsigned short  LangId;        
    unsigned char   FullSpeed;     
    unsigned char   FlagAttach;    
    unsigned char   DCPMaxSize;    
} USBHostInfo_t;

typedef enum TKUSBH_RESULT
{
    TKUSBH_OK      = 0, 
    TKUSBH_NOSUPPORT,   
    TKUSBH_DISCONNECT,  
    TKUSBH_NOINIT,      
    TKUSBH_TIMEOUT,     
    TKUSBH_STALL,       
    TKUSBH_ERROR,       
} TKUSBH_RESULT;

extern USBHostInfo_t USBHostInfo;

/*********************************************************************/
extern int gUsbHostGpioPulldown; 

/****************************************************************************************
                   USB Hostの関数
****************************************************************************************/

/*********************************************************************/
TKUSBH_RESULT tkusbh_init(void);

/*********************************************************************/
TKUSBH_RESULT tkusbh_is_connected();

/*********************************************************************/
TKUSBH_RESULT tkusbh_connect(int timeout_ms);

/*********************************************************************/
TKUSBH_RESULT tkusbh_halfway_connect(int timeout_ms);

/*********************************************************************/
TKUSBH_RESULT tkusbh_disconnect(int timeout_ms);

/*********************************************************************/
int  tkusbh_get_descriptor(unsigned char type,unsigned char index, void *buf, int size);

/*********************************************************************/
int  tkusbh_get_string(unsigned short index, unsigned short langid, char *buf,int buflen);

/*********************************************************************/
int  tkusbh_control_msg(unsigned short req,unsigned short val,
                        unsigned short index,unsigned short len,
                        unsigned char *buf, int timeout);

/*********************************************************************/
TKUSBH_RESULT tkusbh_set_configuration(int configuration);

/*********************************************************************/
int  tkusbh_bulk_write(int ep, unsigned char *bytes, int size,int timeout);

/*********************************************************************/
int  tkusbh_bulk_read(int ep, unsigned char *bytes, int size,int timeout);

typedef enum {
    INTERRUPT_IN, 
    INTERRUPT_OUT 
} INTTRANS_TYPE;

/*********************************************************************/
void tkusbh_start_interrupt_trans(int ep, int time,INTTRANS_TYPE type, void *callback);

/*********************************************************************/
int  tkusbh_interrupt_write(int ep, unsigned char *buf, int size);

/*********************************************************************/
int  tkusbh_interrupt_read(int ep, unsigned char *buf, int size);


// 以下の関数はまだ作っていない
// int  tkusbh_clear_halt(unsigned int ep);
// int  tkusbh_resetep(unsigned int ep);
// int  tkusbh_reset();

/****************************************************************************************
                   USBホストユーティリティ
****************************************************************************************/

#ifdef __cplusplus
 }
#endif

#endif