source: azure_iot_hub_f767zi/trunk/asp_baseplatform/usb/device/tusbd_base.h@ 457

Last change on this file since 457 was 457, checked in by coas-nagasima, 4 years ago

ファイルを追加
  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/x-chdr;charset=UTF-8
File size: 7.3 KB
Line 
1/*
2 * TOPPERS BASE PLATFORM MIDDLEWARE
3 *
4 * Copyright (C) 2017-2017 by TOPPERS PROJECT
5 * Educational Working Group.
6 *
7 * 上記著作権者は，以下の(1)～(4)の条件を満たす場合に限り，本ソフトウェ
8 * ア（本ソフトウェアを改変したものを含む．以下同じ）を使用・複製・改
9 * 変・再配布（以下，利用と呼ぶ）することを無償で許諾する．
10 * (1) 本ソフトウェアをソースコードの形で利用する場合には，上記の著作
11 * 権表示，この利用条件および下記の無保証規定が，そのままの形でソー
12 * スコード中に含まれていること．
13 * (2) 本ソフトウェアを，ライブラリ形式など，他のソフトウェア開発に使
14 * 用できる形で再配布する場合には，再配布に伴うドキュメント（利用
15 * 者マニュアルなど）に，上記の著作権表示，この利用条件および下記
16 * の無保証規定を掲載すること．
17 * (3) 本ソフトウェアを，機器に組み込むなど，他のソフトウェア開発に使
18 * 用できない形で再配布する場合には，次のいずれかの条件を満たすこ
19 * と．
20 * (a) 再配布に伴うドキュメント（利用者マニュアルなど）に，上記の著
21 * 作権表示，この利用条件および下記の無保証規定を掲載すること．
22 * (b) 再配布の形態を，別に定める方法によって，TOPPERSプロジェクトに
23 * 報告すること．
24 * (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
25 * 害からも，上記著作権者およびTOPPERSプロジェクトを免責すること．
26 * また，本ソフトウェアのユーザまたはエンドユーザからのいかなる理
27 * 由に基づく請求からも，上記著作権者およびTOPPERSプロジェクトを
28 * 免責すること．
29 *
30 * 本ソフトウェアは，無保証で提供されているものである．上記著作権者お
31 * よびTOPPERSプロジェクトは，本ソフトウェアに関して，特定の使用目的
32 * に対する適合性も含めて，いかなる保証も行わない．また，本ソフトウェ
33 * アの利用により直接的または間接的に生じたいかなる損害に関しても，そ
34 * の責任を負わない．
35 *
36 * @(#) $Id$
37 */
38/*
39 * USB Device Middleware BASE部定義
40 */
41
42#ifndef _TUSBD_BASE_H_
43#define _TUSBD_BASE_H_
44
45#include "tusb_rtos.h"
46#include "tusb_types.h"
47
48#ifdef __cplusplus
49 extern "C" {
50#endif
51
52#ifndef TUSBD_NUM_ENDPOINT
53#define TUSBD_NUM_ENDPOINT 15
54#endif
55
56#define USB_REQUEST_TYPE_MASK 0x60
57
58#define TUSBD_CONFIG_REMOTE_WAKEUP 0x02
59
60#define USB_FEATURE_EP_HALT 0
61#define USB_FEATURE_REMOTE_WAKEUP 1
62#define USB_FEATURE_TEST_MODE 2
63
64
65
66#define USB_HS_MAX_PACKET_SIZE 512
67#define USB_FS_MAX_PACKET_SIZE 64
68#define USB_MAX_EP0_SIZE USB_FS_MAX_PACKET_SIZE
69
70/*
71 * デバイス状態定義
72 */
73#define TUSBD_STATE_RESET 0 /* 未実行状態 */
74#define TUSBD_STATE_INIT 1 /* 初期化状態 */
75#define TUSBD_STATE_ADDRESSED 2 /* アドレス設定済み状態 */
76#define TUSBD_STATE_CONFIGURED 3 /* エナミュレーション終了状態 */
77#define TUSBD_STATE_SUSPENDED 4 /* サスペンド状態 */
78
79/*
80 * エンドポイント#0状態
81 */
82#define TUSBD_EP0_IDLE 0 /* アイドル状態 */
83#define TUSBD_EP0_SETUP 1 /* SETUP状態 */
84#define TUSBD_EP0_DATAIN 2 /* DATAIN状態 */
85#define TUSBD_EP0_DATAOUT 3 /* DATAOUT状態 */
86#define TUSBD_EP0_STATUSIN 4 /* STATUSIN状態 */
87#define TUSBD_EP0_STATUSOUT 5 /* STATUSOUT状態 */
88
89/* bmAttributes in configuration descriptor */
90/* C_RESERVED must always be set */
91#define C_RESERVED (1<<7)
92#define C_SELF_POWERED (1<<6)
93#define C_REMOTE_WAKEUP (1<<5)
94
95/* bMaxPower in configuration descriptor */
96#define C_POWER(mA) ((mA)/2)
97
98/*
99 * エンドポイント管理型
100 */
101typedef struct
102{
103 uint16_t status;
104 uint16_t maxpacket;
105 uint32_t xfersize;
106 uint32_t remlength;
107} TUSBD_Endpoint_t;
108
109/*
110 * USBデバイスハンドラ
111 */
112typedef struct
113{
114 uint8_t devData[32];
115 uint8_t id;
116 uint8_t dev_speed;
117 uint8_t dev_address;
118 uint8_t dev_config;
119 uint8_t dev_test_mode;
120 uint8_t dev_remote_wakeup;
121 uint8_t ep0_state;
122 uint16_t ep0_data_len;
123 uint8_t dev_state;
124 uint8_t dev_old_state;
125 TUSBD_Endpoint_t ep_in[TUSBD_NUM_ENDPOINT];
126 TUSBD_Endpoint_t ep_out[TUSBD_NUM_ENDPOINT];
127
128 UsbSetupRequest request;
129 void *pClassData;
130 void *pSysData;
131 void *pUsrData;
132 void (*makeDescriptor)(uint8_t speed);
133} TUSBD_Handle_t;
134
135#include "tusbd_conf.h"
136
137#ifndef MAX_PACKET_SIZE_HS_EPBULK
138#define MAX_PACKET_SIZE_HS_EPBULK 512
139#endif
140#ifndef MAX_PACKET_SIZE_FS_EPBULK
141#define MAX_PACKET_SIZE_FS_EPBULK 64
142#endif
143
144
145/*
146 * 関数プロトタイプ宣言
147 */
148TUSBD_ERCODE tusbdInit(TUSBD_Handle_t *pdevice, uint8_t id);
149TUSBD_ERCODE tusbdDeInit(TUSBD_Handle_t *pdevice);
150TUSBD_ERCODE tusbdStart(TUSBD_Handle_t *pdevice);
151TUSBD_ERCODE tusbdStop(TUSBD_Handle_t *pdevice);
152
153TUSBD_ERCODE tusbdSetupStage(TUSBD_Handle_t *pdevice, uint8_t *psetup);
154TUSBD_ERCODE tusbdDataOutStage(TUSBD_Handle_t *pdevice, uint8_t epnum, uint8_t *pdata);
155TUSBD_ERCODE tusbdDataInStage(TUSBD_Handle_t *pdevice, uint8_t epnum, uint8_t *pdata);
156
157TUSBD_ERCODE tusbdReset(TUSBD_Handle_t *pdevice);
158TUSBD_ERCODE tusbdSetSpeed(TUSBD_Handle_t *pdevice, uint8_t speed);
159TUSBD_ERCODE tusbdSuspend(TUSBD_Handle_t *pdevice);
160TUSBD_ERCODE tusbdResume(TUSBD_Handle_t *pdevice);
161TUSBD_ERCODE tusbdIsoInIncomplete(TUSBD_Handle_t *pdevice, uint8_t epnum);
162TUSBD_ERCODE tusbdIsoOutIncomplete(TUSBD_Handle_t *pdevice, uint8_t epnum);
163
164TUSBD_ERCODE tusbdDeviceConnected(TUSBD_Handle_t *pdevice);
165TUSBD_ERCODE tusbdDeviceDisconnected(TUSBD_Handle_t *pdevice);
166
167TUSBD_ERCODE tusbdControlSendData(TUSBD_Handle_t *pdevice, uint8_t *buf, uint16_t len);
168TUSBD_ERCODE tusbdControlReceiveStart(TUSBD_Handle_t *pdevice, uint8_t *pbuf, uint16_t len);
169TUSBD_ERCODE tusbdControlSendStatus(TUSBD_Handle_t *pdevice);
170TUSBD_ERCODE tusbdControlReceiveStatus(TUSBD_Handle_t *pdevice);
171void tusbdControlSendStall(TUSBD_Handle_t *pdevice, UsbSetupRequest *req);
172
173#define tusbdControlContinueSendData(d, b, l) tusbdDriverStartTransmit((d), 0x00, (b), (l))
174#define tusbdControlContinueReceive(d, b, l) tusbdDriverSetupReceive((d), 0x00, (b), (l))
175
176uint8_t *tusbdFindDescriptor(TUSBD_Handle_t *pdevice, uint8_t type);
177
178#ifdef __cplusplus
179}
180#endif
181
182#endif /* _TUSBD_BASE_H_ */
183
Note: See TracBrowser for help on using the repository browser.