source: azure_iot_hub_riscv/trunk/asp_baseplatform/usb/host/SERIAL/tusbh_serial.h@ 453

Last change on this file since 453 was 453, 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: 6.1 KB
Line 
1/*
2 * TOPPERS BASE PLATFORM MIDDLEWARE
3 *
4 * Copyright (C) 2017-2018 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 Host Middleware CDC:SERIAL部定義
40 */
41
42#ifndef _HUSBH_SERIAL_H_
43#define _HUSBH_SERIAL_H_
44
45#include "tusbh_base.h"
46
47#ifdef __cplusplus
48 extern "C" {
49#endif
50
51
52/*
53 * COMMUNCATION SUB CLASS CODE定義
54 */
55#define COMMUNICATIONS_INTERFACE_CLASS 0x00
56#define DIRECT_LINE_CONTROL_MODEL 0x01
57#define ABSTRACT_CONTROL_MODEL 0x02
58#define TELEPHONE_CONTROL_MODEL 0x03
59#define MULTICHANNEL_CONTROL_MODEL 0x04
60#define CAPI_CONTROL_MODEL 0x05
61#define ETHERNET_NETWORKING_CONTROL_MODEL 0x06
62#define ATM_NETWORKING_CONTROL_MODEL 0x07
63#define WIRELESS_HANDSET_CONTROL_MODEL 0x08
64#define MOBILE_DIRECT_LINE_MODEL 0x0A
65#define ETHERNET_EMULATION_MODEL 0x0C
66#define NETWORK_CONTROL_MODEL 0x0D
67
68
69/*
70 * COMMUNICATION INTERFCAE CLASS 制御プロトコルコード定義
71 */
72#define CDC_NO_SPECIFIC_PROTOCOL_CODE 0x00
73#define CDC_ITU_T_V_250 0x01
74#define CDC_VENDOR_SPECIFIC 0xFF
75
76/*
77 * DATA INTERFCAE CLASS 制御プロトコルコード定義
78 */
79#define DIC_NO_SPECIFIC_PROTOCOL_CODE 0x00
80#define DIC_USBNCM_1_0 0x01
81
82
83#define CDC_SET_LINE_CODING 0x20
84#define CDC_GET_LINE_CODING 0x21
85#define CDC_SET_CONTROL_LINE_STATE 0x22
86#define CDC_SEND_BREAK 0x23
87
88#define CDC_REQUEST_GETLINE_TYPE (USB_DEVICE_TO_HOST | USB_REQUEST_TYPE_CLASS | USB_RECIPIENT_INTERFACE)
89#define CDC_REQUEST_SETLINE_TYPE (USB_HOST_TO_DEVICE | USB_REQUEST_TYPE_CLASS | USB_RECIPIENT_INTERFACE)
90
91#define LINE_CODING_STRUCTURE_SIZE 0x07
92
93/*
94 * CDCコールバックコード定義
95 */
96#define CDC_LINE_STATUS_CHANGED 1
97#define CDC_LINE_STATUS_SENDED 2
98#define CDC_LINE_STATUS_RECEIVED 3
99
100/*
101 * CDCプロセスの状態定義
102 */
103enum
104{
105 CDC_PROCESS_INIT = 0,
106 CDC_PROCESS_INIT_WAIT,
107 CDC_PROCESS_IDLE,
108 CDC_PROCESS_SET_LINE_CODING,
109 CDC_PROCESS_SET_LINE_CODING_WAIT,
110 CDC_PROCESS_GET_LINE_CODING,
111 CDC_PROCESS_SEND,
112 CDC_PROCESS_RECEIVE,
113 CDC_PROCESS_ERROR,
114 CDC_PROCESS_ERROR_WAIT
115};
116
117/*
118 * CDCハンドラ定義
119 */
120typedef struct
121{
122 TUSBH_Device_t *pDev;
123 uint8_t state;
124 uint8_t dummy;
125 uint16_t RxTrnPktSize;
126 uint16_t TxTrnPktSize;
127
128 uint8_t CommInPipe;
129 uint8_t CommInEp;
130 uint16_t CommInEpSize;
131 uint8_t InPipe;
132 uint8_t OutPipe;
133 uint8_t OutEp;
134 uint8_t InEp;
135 uint16_t OutEpSize;
136 uint16_t InEpSize;
137 uint32_t RxTrnLength;
138 uint32_t RxTrnSize;
139 uint8_t *pRxTrnBuff;
140 uint32_t TxTrnLength;
141 uint32_t TxTrnSize;
142 uint8_t *pTxTrnBuff;
143 uint32_t timer;
144 uint32_t urb_wait;
145 ID rw_taskid;
146 uint32_t rw_status;
147 Line_Coding_t oLineCoding;
148 Line_Coding_t uLineCoding;
149} CDC_Handle_t;
150
151
152void tusbhLinkSERIAL(TUSBH_Handle_t *phost);
153TUSBH_ERCODE tusbhCdcSetLineCoding(TUSBH_Handle_t *phost, uint8_t unit, Line_Coding_t *linecod);
154TUSBH_ERCODE tusbhCdcGetLineCoding(TUSBH_Handle_t *phost, uint8_t unit, Line_Coding_t *linecod);
155TUSBH_ERCODE tusbhCdcSend(TUSBH_Handle_t *phost, uint8_t unit, uint8_t *pbuf, uint32_t length);
156TUSBH_ERCODE tusbhCdcReceive(TUSBH_Handle_t *phost, uint8_t unit, uint8_t *pbuf, uint32_t *length, uint32_t timeout);
157void tusbhSetCdcCallBack(TUSBH_Handle_t *phost, void (*func)(TUSBH_Device_t *p, uint8_t));
158
159
160#ifdef __cplusplus
161}
162#endif
163
164#endif /* _HUSBH_SERIAL_H_ */
165
Note: See TracBrowser for help on using the repository browser.