BALTECH SDK wrapper functions reference
usbhost.h
Go to the documentation of this file.
1 
10 #ifndef __BRP_BALTECH_SDK_CMDS_USBHOST_H__
11 #define __BRP_BALTECH_SDK_CMDS_USBHOST_H__
12 #include "../typedefs.h"
13 #ifdef BALTECH_SDK_INTERNAL
14 
17 #define BRP_UsbHost_UsbhstErrNotconnected BRP_ERR_STATUS(0x4400, 0x01)
18 #endif // BALTECH_SDK_INTERNAL
19 #ifdef BALTECH_SDK_INTERNAL
20 
23 #define BRP_UsbHost_UsbhstErrTimeout BRP_ERR_STATUS(0x4400, 0x02)
24 #endif // BALTECH_SDK_INTERNAL
25 #ifdef BALTECH_SDK_INTERNAL
26 
29 #define BRP_UsbHost_UsbhstErrNack BRP_ERR_STATUS(0x4400, 0x03)
30 #endif // BALTECH_SDK_INTERNAL
31 #ifdef BALTECH_SDK_INTERNAL
32 
35 #define BRP_UsbHost_UsbhstErrStall BRP_ERR_STATUS(0x4400, 0x04)
36 #endif // BALTECH_SDK_INTERNAL
37 #ifdef BALTECH_SDK_INTERNAL
38 
41 #define BRP_UsbHost_UsbhstErrTransfer BRP_ERR_STATUS(0x4400, 0x05)
42 #endif // BALTECH_SDK_INTERNAL
43 #ifdef BALTECH_SDK_INTERNAL
44 
47 #define BRP_UsbHost_UsbhstErrUnexpectedPkt BRP_ERR_STATUS(0x4400, 0x06)
48 #endif // BALTECH_SDK_INTERNAL
49 #ifdef BALTECH_SDK_INTERNAL
50 
53 #define BRP_UsbHost_UsbhstErrBufferoverflow BRP_ERR_STATUS(0x4400, 0x07)
54 #endif // BALTECH_SDK_INTERNAL
55 #ifdef BALTECH_SDK_INTERNAL
56 
59 #define BRP_UsbHost_UsbhstErrSetupPipes BRP_ERR_STATUS(0x4400, 0x20)
60 #endif // BALTECH_SDK_INTERNAL
61 #ifdef BALTECH_SDK_INTERNAL
62 typedef struct {
63  brp_protocol protocol;
64  bool Enable;
65 } brp_UsbHost_Enable_t;
73 #ifdef BRP_SUPPORT_LEGACY_METHODS
74 brp_errcode brp_UsbHost_Enable(brp_protocol protocol, bool Enable);
75 #else
76 brp_errcode brp_UsbHost_Enable(brp_UsbHost_Enable_t params);
77 #endif
78 #endif // BALTECH_SDK_INTERNAL
79 #ifdef BALTECH_SDK_INTERNAL
80 typedef struct {
81  brp_protocol protocol;
82  bool* Connected;
83 } brp_UsbHost_IsConnected_t;
91 #ifdef BRP_SUPPORT_LEGACY_METHODS
92 brp_errcode brp_UsbHost_IsConnected(brp_protocol protocol, bool* Connected);
93 #else
94 brp_errcode brp_UsbHost_IsConnected(brp_UsbHost_IsConnected_t params);
95 #endif
96 #endif // BALTECH_SDK_INTERNAL
97 #ifdef BALTECH_SDK_INTERNAL
98 typedef struct {
99  brp_protocol protocol;
100  brp_UsbHost_SetupPipes_Pipes_Entry* Pipes;
101  size_t Pipes_len;
102 } brp_UsbHost_SetupPipes_t;
111 #ifdef BRP_SUPPORT_LEGACY_METHODS
112 brp_errcode brp_UsbHost_SetupPipes(brp_protocol protocol, brp_UsbHost_SetupPipes_Pipes_Entry* Pipes, size_t Pipes_len);
113 #else
114 brp_errcode brp_UsbHost_SetupPipes(brp_UsbHost_SetupPipes_t params);
115 #endif
116 #endif // BALTECH_SDK_INTERNAL
117 #ifdef BALTECH_SDK_INTERNAL
118 typedef struct {
119  brp_protocol protocol;
120  unsigned Address;
121 } brp_UsbHost_SetAddr_t;
129 #ifdef BRP_SUPPORT_LEGACY_METHODS
130 brp_errcode brp_UsbHost_SetAddr(brp_protocol protocol, unsigned Address);
131 #else
132 brp_errcode brp_UsbHost_SetAddr(brp_UsbHost_SetAddr_t params);
133 #endif
134 #endif // BALTECH_SDK_INTERNAL
135 #ifdef BALTECH_SDK_INTERNAL
136 typedef struct {
137  brp_protocol protocol;
138 } brp_UsbHost_Reset_t;
145 #ifdef BRP_SUPPORT_LEGACY_METHODS
146 brp_errcode brp_UsbHost_Reset(brp_protocol protocol);
147 #else
148 brp_errcode brp_UsbHost_Reset(brp_UsbHost_Reset_t params);
149 #endif
150 #endif // BALTECH_SDK_INTERNAL
151 #ifdef BALTECH_SDK_INTERNAL
152 typedef struct {
153  brp_protocol protocol;
154  brp_buf SetupData;
155  unsigned PipeNo;
156  unsigned Timeout;
157 } brp_UsbHost_TransRawSetup_t;
167 #ifdef BRP_SUPPORT_LEGACY_METHODS
168 brp_errcode brp_UsbHost_TransRawSetup(brp_protocol protocol, brp_buf SetupData, unsigned PipeNo, unsigned Timeout);
169 #else
170 brp_errcode brp_UsbHost_TransRawSetup(brp_UsbHost_TransRawSetup_t params);
171 #endif
172 #endif // BALTECH_SDK_INTERNAL
173 #ifdef BALTECH_SDK_INTERNAL
174 typedef struct {
175  brp_protocol protocol;
176  brp_buf SetupData;
177  unsigned PipeNo;
178  unsigned Timeout;
179  brp_buf* InData;
180  size_t* InData_len;
181  brp_mempool *mempool;
182 } brp_UsbHost_TransSetupIn_t;
195 #ifdef BRP_SUPPORT_LEGACY_METHODS
196 brp_errcode brp_UsbHost_TransSetupIn(brp_protocol protocol, brp_buf SetupData, unsigned PipeNo, unsigned Timeout, brp_buf* InData, size_t* InData_len, brp_mempool *mempool);
197 #else
198 brp_errcode brp_UsbHost_TransSetupIn(brp_UsbHost_TransSetupIn_t params);
199 #endif
200 #endif // BALTECH_SDK_INTERNAL
201 #ifdef BALTECH_SDK_INTERNAL
202 typedef struct {
203  brp_protocol protocol;
204  brp_buf SetupData;
205  brp_buf OutData;
206  size_t OutData_len;
207  unsigned PipeNo;
208  unsigned Timeout;
209 } brp_UsbHost_TransSetupOut_t;
221 #ifdef BRP_SUPPORT_LEGACY_METHODS
222 brp_errcode brp_UsbHost_TransSetupOut(brp_protocol protocol, brp_buf SetupData, brp_buf OutData, size_t OutData_len, unsigned PipeNo, unsigned Timeout);
223 #else
224 brp_errcode brp_UsbHost_TransSetupOut(brp_UsbHost_TransSetupOut_t params);
225 #endif
226 #endif // BALTECH_SDK_INTERNAL
227 #ifdef BALTECH_SDK_INTERNAL
228 typedef struct {
229  brp_protocol protocol;
230  unsigned PipeNo;
231  unsigned Timeout;
232  brp_buf* InData;
233  size_t* InData_len;
234  brp_mempool *mempool;
235 } brp_UsbHost_TransIn_t;
247 #ifdef BRP_SUPPORT_LEGACY_METHODS
248 brp_errcode brp_UsbHost_TransIn(brp_protocol protocol, unsigned PipeNo, unsigned Timeout, brp_buf* InData, size_t* InData_len, brp_mempool *mempool);
249 #else
250 brp_errcode brp_UsbHost_TransIn(brp_UsbHost_TransIn_t params);
251 #endif
252 #endif // BALTECH_SDK_INTERNAL
253 #ifdef BALTECH_SDK_INTERNAL
254 typedef struct {
255  brp_protocol protocol;
256  brp_buf OutData;
257  size_t OutData_len;
258  unsigned PipeNo;
259  bool Continue;
260  unsigned Timeout;
261 } brp_UsbHost_TransOut_t;
273 #ifdef BRP_SUPPORT_LEGACY_METHODS
274 brp_errcode brp_UsbHost_TransOut(brp_protocol protocol, brp_buf OutData, size_t OutData_len, unsigned PipeNo, bool Continue, unsigned Timeout);
275 #else
276 brp_errcode brp_UsbHost_TransOut(brp_UsbHost_TransOut_t params);
277 #endif
278 #endif // BALTECH_SDK_INTERNAL
279 #ifdef BALTECH_SDK_INTERNAL
280 typedef struct {
281  brp_protocol protocol;
282 } brp_UsbHost_Suspend_t;
289 #ifdef BRP_SUPPORT_LEGACY_METHODS
290 brp_errcode brp_UsbHost_Suspend(brp_protocol protocol);
291 #else
292 brp_errcode brp_UsbHost_Suspend(brp_UsbHost_Suspend_t params);
293 #endif
294 #endif // BALTECH_SDK_INTERNAL
295 #ifdef BALTECH_SDK_INTERNAL
296 typedef struct {
297  brp_protocol protocol;
298 } brp_UsbHost_Resume_t;
305 #ifdef BRP_SUPPORT_LEGACY_METHODS
306 brp_errcode brp_UsbHost_Resume(brp_protocol protocol);
307 #else
308 brp_errcode brp_UsbHost_Resume(brp_UsbHost_Resume_t params);
309 #endif
310 #endif // BALTECH_SDK_INTERNAL
311 #endif
312 
brp_errcode
unsigned int brp_errcode
This type is used library-wide for passing error codes in the return value of functions.
Definition: errorcodes.h:23
brp_protocol
struct brp_protocol_t * brp_protocol
This is a generic handle of a protocol.
Definition: protocol.h:34
brp_mempool
struct brp_mempool_object_t * brp_mempool
mempool handle.
Definition: mempool.h:29
brp_buf
unsigned char * brp_buf
represents a pointer to a protocol data buffer.
Definition: common.h:61