BALTECH SDK wrapper functions reference
dhwctrl.h
Go to the documentation of this file.
1 
10 #ifndef __BRP_BALTECH_SDK_CMDS_DHWCTRL_H__
11 #define __BRP_BALTECH_SDK_CMDS_DHWCTRL_H__
12 #include "../typedefs.h"
13 #ifdef BALTECH_SDK_INTERNAL
14 
17 #define BRP_DHWCtrl_ErrInvalidIndex BRP_ERR_STATUS(0xE100, 0x01)
18 #endif // BALTECH_SDK_INTERNAL
19 #ifdef BALTECH_SDK_INTERNAL
20 
23 #define BRP_DHWCtrl_ErrNotActive BRP_ERR_STATUS(0xE100, 0x02)
24 #endif // BALTECH_SDK_INTERNAL
25 #ifdef BALTECH_SDK_INTERNAL
26 
29 #define BRP_DHWCtrl_ErrAlreadyActive BRP_ERR_STATUS(0xE100, 0x03)
30 #endif // BALTECH_SDK_INTERNAL
31 #ifdef BALTECH_SDK_INTERNAL
32 
35 #define BRP_DHWCtrl_ErrInvalidParam BRP_ERR_STATUS(0xE100, 0x04)
36 #endif // BALTECH_SDK_INTERNAL
37 #ifdef BALTECH_SDK_INTERNAL
38 
41 #define BRP_DHWCtrl_ErrTimeout BRP_ERR_STATUS(0xE100, 0x05)
42 #endif // BALTECH_SDK_INTERNAL
43 #ifdef BALTECH_SDK_INTERNAL
44 
47 #define BRP_DHWCtrl_ErrEthFrameTooBig BRP_ERR_STATUS(0xE100, 0x10)
48 #endif // BALTECH_SDK_INTERNAL
49 #ifdef BALTECH_SDK_INTERNAL
50 
53 #define BRP_DHWCtrl_ErrUsbNotConnected BRP_ERR_STATUS(0xE100, 0x20)
54 #endif // BALTECH_SDK_INTERNAL
55 #ifdef BALTECH_SDK_INTERNAL
56 
59 #define BRP_DHWCtrl_ErrUsbStall BRP_ERR_STATUS(0xE100, 0x21)
60 #endif // BALTECH_SDK_INTERNAL
61 #ifdef BALTECH_SDK_INTERNAL
62 
65 #define BRP_DHWCtrl_ErrUsbTransfer BRP_ERR_STATUS(0xE100, 0x22)
66 #endif // BALTECH_SDK_INTERNAL
67 #ifdef BALTECH_SDK_INTERNAL
68 
71 #define BRP_DHWCtrl_ErrUsbBufferOverflow BRP_ERR_STATUS(0xE100, 0x23)
72 #endif // BALTECH_SDK_INTERNAL
73 #ifdef BALTECH_SDK_INTERNAL
74 
77 #define BRP_DHWCtrl_ErrFlashRange BRP_ERR_STATUS(0xE100, 0x30)
78 #endif // BALTECH_SDK_INTERNAL
79 #ifdef BALTECH_SDK_INTERNAL
80 
83 #define BRP_DHWCtrl_ErrFlashWrite BRP_ERR_STATUS(0xE100, 0x31)
84 #endif // BALTECH_SDK_INTERNAL
85 #ifdef BALTECH_SDK_INTERNAL
86 
89 #define BRP_DHWCtrl_ErrFlashErase BRP_ERR_STATUS(0xE100, 0x32)
90 #endif // BALTECH_SDK_INTERNAL
91 #ifdef BALTECH_SDK_INTERNAL
92 
95 #define BRP_DHWCtrl_ErrHardware BRP_ERR_STATUS(0xE100, 0xFF)
96 #endif // BALTECH_SDK_INTERNAL
97 #ifdef BALTECH_SDK_INTERNAL
98 typedef struct {
99  brp_protocol protocol;
100  unsigned Index;
101  brp_DHWCtrlPinset Pinset;
102  brp_buf MacAddress;
103 } brp_DHWCtrl_EthActivate_t;
113 #ifdef BRP_SUPPORT_LEGACY_METHODS
114 brp_errcode brp_DHWCtrl_EthActivate(brp_protocol protocol, unsigned _input_Index, brp_DHWCtrlPinset _input_Pinset, brp_buf _input_MacAddress);
115 #else
116 brp_errcode brp_DHWCtrl_EthActivate(brp_DHWCtrl_EthActivate_t params);
117 #endif
118 typedef struct {
119  brp_protocol protocol;
120  unsigned Index;
121 } brp_DHWCtrl_EthDeactivate_t;
129 #ifdef BRP_SUPPORT_LEGACY_METHODS
130 brp_errcode brp_DHWCtrl_EthDeactivate(brp_protocol protocol, unsigned _input_Index);
131 #else
132 brp_errcode brp_DHWCtrl_EthDeactivate(brp_DHWCtrl_EthDeactivate_t params);
133 #endif
134 typedef struct {
135  brp_protocol protocol;
136  unsigned Index;
137  brp_buf DstMac;
138  brp_buf SrcMac;
139  brp_DHWCtrlEtherType EtherType;
140  brp_buf Payload;
141  size_t Payload_len;
142 } brp_DHWCtrl_EthSendFrame_t;
155 #ifdef BRP_SUPPORT_LEGACY_METHODS
156 brp_errcode brp_DHWCtrl_EthSendFrame(brp_protocol protocol, unsigned _input_Index, brp_buf _input_DstMac, brp_buf _input_SrcMac, brp_DHWCtrlEtherType _input_EtherType, brp_buf _input_Payload, size_t _input_Payload_len);
157 #else
158 brp_errcode brp_DHWCtrl_EthSendFrame(brp_DHWCtrl_EthSendFrame_t params);
159 #endif
160 typedef struct {
161  brp_protocol protocol;
162  unsigned Index;
163  unsigned TimeoutMs;
164  unsigned* TimestampUs;
165  unsigned* Seq;
166  bool* RxOverflow;
167  bool* CrcError;
168  bool* Truncated;
169  brp_buf* DstMac;
170  brp_buf* SrcMac;
171  brp_DHWCtrlEtherType* EtherType;
172  brp_buf* Payload;
173  size_t* Payload_len;
174  brp_mempool *mempool;
175 } brp_DHWCtrl_EthRecvFrame_t;
195 #ifdef BRP_SUPPORT_LEGACY_METHODS
196 brp_errcode brp_DHWCtrl_EthRecvFrame(brp_protocol protocol, unsigned _input_Index, unsigned _input_TimeoutMs, unsigned* TimestampUs, unsigned* Seq, bool* RxOverflow, bool* CrcError, bool* Truncated, brp_buf* DstMac, brp_buf* SrcMac, brp_DHWCtrlEtherType* EtherType, brp_buf* Payload, size_t* Payload_len, brp_mempool *mempool);
197 #else
198 brp_errcode brp_DHWCtrl_EthRecvFrame(brp_DHWCtrl_EthRecvFrame_t params);
199 #endif
200 typedef struct {
201  brp_protocol protocol;
202  unsigned Index;
203  brp_DHWCtrlEthLinkState State;
204  unsigned TimeoutMs;
205 } brp_DHWCtrl_EthWaitLinkState_t;
215 #ifdef BRP_SUPPORT_LEGACY_METHODS
216 brp_errcode brp_DHWCtrl_EthWaitLinkState(brp_protocol protocol, unsigned _input_Index, brp_DHWCtrlEthLinkState _input_State, unsigned _input_TimeoutMs);
217 #else
218 brp_errcode brp_DHWCtrl_EthWaitLinkState(brp_DHWCtrl_EthWaitLinkState_t params);
219 #endif
220 typedef struct {
221  brp_protocol protocol;
222  unsigned Index;
223  brp_DHWCtrl_EthGetCommMode_Speed* Speed;
224  brp_DHWCtrl_EthGetCommMode_Duplex* Duplex;
225 } brp_DHWCtrl_EthGetCommMode_t;
235 #ifdef BRP_SUPPORT_LEGACY_METHODS
236 brp_errcode brp_DHWCtrl_EthGetCommMode(brp_protocol protocol, unsigned _input_Index, brp_DHWCtrl_EthGetCommMode_Speed* Speed, brp_DHWCtrl_EthGetCommMode_Duplex* Duplex);
237 #else
238 brp_errcode brp_DHWCtrl_EthGetCommMode(brp_DHWCtrl_EthGetCommMode_t params);
239 #endif
240 typedef struct {
241  brp_protocol protocol;
242  brp_DHWCtrlGpioPin Pin;
243  brp_DHWCtrl_GpioConfigure_Mode Mode;
244 } brp_DHWCtrl_GpioConfigure_t;
253 #ifdef BRP_SUPPORT_LEGACY_METHODS
254 brp_errcode brp_DHWCtrl_GpioConfigure(brp_protocol protocol, brp_DHWCtrlGpioPin _input_Pin, brp_DHWCtrl_GpioConfigure_Mode _input_Mode);
255 #else
256 brp_errcode brp_DHWCtrl_GpioConfigure(brp_DHWCtrl_GpioConfigure_t params);
257 #endif
258 typedef struct {
259  brp_protocol protocol;
260  brp_DHWCtrlGpioPin Pin;
261  brp_DHWCtrlGpioLevel Level;
262 } brp_DHWCtrl_GpioSetState_t;
271 #ifdef BRP_SUPPORT_LEGACY_METHODS
272 brp_errcode brp_DHWCtrl_GpioSetState(brp_protocol protocol, brp_DHWCtrlGpioPin _input_Pin, brp_DHWCtrlGpioLevel _input_Level);
273 #else
274 brp_errcode brp_DHWCtrl_GpioSetState(brp_DHWCtrl_GpioSetState_t params);
275 #endif
276 typedef struct {
277  brp_protocol protocol;
278  brp_DHWCtrlGpioPin Pin;
279  brp_DHWCtrlGpioLevel Level;
280  unsigned TimeoutMs;
281 } brp_DHWCtrl_GpioWaitState_t;
291 #ifdef BRP_SUPPORT_LEGACY_METHODS
292 brp_errcode brp_DHWCtrl_GpioWaitState(brp_protocol protocol, brp_DHWCtrlGpioPin _input_Pin, brp_DHWCtrlGpioLevel _input_Level, unsigned _input_TimeoutMs);
293 #else
294 brp_errcode brp_DHWCtrl_GpioWaitState(brp_DHWCtrl_GpioWaitState_t params);
295 #endif
296 typedef struct {
297  brp_protocol protocol;
298  unsigned Index;
299  brp_DHWCtrlPinset Pinset;
300 } brp_DHWCtrl_UsbHostActivate_t;
309 #ifdef BRP_SUPPORT_LEGACY_METHODS
310 brp_errcode brp_DHWCtrl_UsbHostActivate(brp_protocol protocol, unsigned _input_Index, brp_DHWCtrlPinset _input_Pinset);
311 #else
312 brp_errcode brp_DHWCtrl_UsbHostActivate(brp_DHWCtrl_UsbHostActivate_t params);
313 #endif
314 typedef struct {
315  brp_protocol protocol;
316  unsigned Index;
317 } brp_DHWCtrl_UsbHostDeactivate_t;
325 #ifdef BRP_SUPPORT_LEGACY_METHODS
326 brp_errcode brp_DHWCtrl_UsbHostDeactivate(brp_protocol protocol, unsigned _input_Index);
327 #else
328 brp_errcode brp_DHWCtrl_UsbHostDeactivate(brp_DHWCtrl_UsbHostDeactivate_t params);
329 #endif
330 typedef struct {
331  brp_protocol protocol;
332  unsigned Index;
333 } brp_DHWCtrl_UsbHostBusReset_t;
341 #ifdef BRP_SUPPORT_LEGACY_METHODS
342 brp_errcode brp_DHWCtrl_UsbHostBusReset(brp_protocol protocol, unsigned _input_Index);
343 #else
344 brp_errcode brp_DHWCtrl_UsbHostBusReset(brp_DHWCtrl_UsbHostBusReset_t params);
345 #endif
346 typedef struct {
347  brp_protocol protocol;
348  unsigned Index;
349 } brp_DHWCtrl_UsbHostBusSuspend_t;
357 #ifdef BRP_SUPPORT_LEGACY_METHODS
358 brp_errcode brp_DHWCtrl_UsbHostBusSuspend(brp_protocol protocol, unsigned _input_Index);
359 #else
360 brp_errcode brp_DHWCtrl_UsbHostBusSuspend(brp_DHWCtrl_UsbHostBusSuspend_t params);
361 #endif
362 typedef struct {
363  brp_protocol protocol;
364  unsigned Index;
365 } brp_DHWCtrl_UsbHostBusResume_t;
373 #ifdef BRP_SUPPORT_LEGACY_METHODS
374 brp_errcode brp_DHWCtrl_UsbHostBusResume(brp_protocol protocol, unsigned _input_Index);
375 #else
376 brp_errcode brp_DHWCtrl_UsbHostBusResume(brp_DHWCtrl_UsbHostBusResume_t params);
377 #endif
378 typedef struct {
379  brp_protocol protocol;
380  unsigned Index;
381  brp_DHWCtrlUsbPortState State;
382  unsigned TimeoutMs;
383  brp_DHWCtrl_UsbHostWaitPortStatus_Speed* Speed;
384 } brp_DHWCtrl_UsbHostWaitPortStatus_t;
395 #ifdef BRP_SUPPORT_LEGACY_METHODS
396 brp_errcode brp_DHWCtrl_UsbHostWaitPortStatus(brp_protocol protocol, unsigned _input_Index, brp_DHWCtrlUsbPortState _input_State, unsigned _input_TimeoutMs, brp_DHWCtrl_UsbHostWaitPortStatus_Speed* Speed);
397 #else
398 brp_errcode brp_DHWCtrl_UsbHostWaitPortStatus(brp_DHWCtrl_UsbHostWaitPortStatus_t params);
399 #endif
400 typedef struct {
401  brp_protocol protocol;
402  unsigned Index;
403  unsigned Addr;
404  unsigned Mps;
405  brp_buf Setup;
406  unsigned InLen;
407  unsigned TimeoutMs;
408  brp_buf* InData;
409  size_t* InData_len;
410  brp_mempool *mempool;
411 } brp_DHWCtrl_UsbHostTransferCtrlIn_t;
427 #ifdef BRP_SUPPORT_LEGACY_METHODS
428 brp_errcode brp_DHWCtrl_UsbHostTransferCtrlIn(brp_protocol protocol, unsigned _input_Index, unsigned _input_Addr, unsigned _input_Mps, brp_buf _input_Setup, unsigned _input_InLen, unsigned _input_TimeoutMs, brp_buf* InData, size_t* InData_len, brp_mempool *mempool);
429 #else
430 brp_errcode brp_DHWCtrl_UsbHostTransferCtrlIn(brp_DHWCtrl_UsbHostTransferCtrlIn_t params);
431 #endif
432 typedef struct {
433  brp_protocol protocol;
434  unsigned Index;
435  unsigned Addr;
436  unsigned Mps;
437  brp_buf Setup;
438  brp_buf OutData;
439  size_t OutData_len;
440  unsigned TimeoutMs;
441 } brp_DHWCtrl_UsbHostTransferCtrlOut_t;
455 #ifdef BRP_SUPPORT_LEGACY_METHODS
456 brp_errcode brp_DHWCtrl_UsbHostTransferCtrlOut(brp_protocol protocol, unsigned _input_Index, unsigned _input_Addr, unsigned _input_Mps, brp_buf _input_Setup, brp_buf _input_OutData, size_t _input_OutData_len, unsigned _input_TimeoutMs);
457 #else
458 brp_errcode brp_DHWCtrl_UsbHostTransferCtrlOut(brp_DHWCtrl_UsbHostTransferCtrlOut_t params);
459 #endif
460 typedef struct {
461  brp_protocol protocol;
462  unsigned Index;
463  unsigned Addr;
464  unsigned Ep;
465  brp_DHWCtrlUsbTransferAttr Attr;
466  unsigned Mps;
467  unsigned MaxLen;
468  unsigned TimeoutMs;
469  brp_buf* Data;
470  size_t* Data_len;
471  brp_mempool *mempool;
472 } brp_DHWCtrl_UsbHostTransferIn_t;
489 #ifdef BRP_SUPPORT_LEGACY_METHODS
490 brp_errcode brp_DHWCtrl_UsbHostTransferIn(brp_protocol protocol, unsigned _input_Index, unsigned _input_Addr, unsigned _input_Ep, brp_DHWCtrlUsbTransferAttr _input_Attr, unsigned _input_Mps, unsigned _input_MaxLen, unsigned _input_TimeoutMs, brp_buf* Data, size_t* Data_len, brp_mempool *mempool);
491 #else
492 brp_errcode brp_DHWCtrl_UsbHostTransferIn(brp_DHWCtrl_UsbHostTransferIn_t params);
493 #endif
494 typedef struct {
495  brp_protocol protocol;
496  unsigned Index;
497  unsigned Addr;
498  unsigned Ep;
499  brp_DHWCtrlUsbTransferAttr Attr;
500  unsigned Mps;
501  brp_buf Data;
502  size_t Data_len;
503  unsigned TimeoutMs;
504 } brp_DHWCtrl_UsbHostTransferOut_t;
519 #ifdef BRP_SUPPORT_LEGACY_METHODS
520 brp_errcode brp_DHWCtrl_UsbHostTransferOut(brp_protocol protocol, unsigned _input_Index, unsigned _input_Addr, unsigned _input_Ep, brp_DHWCtrlUsbTransferAttr _input_Attr, unsigned _input_Mps, brp_buf _input_Data, size_t _input_Data_len, unsigned _input_TimeoutMs);
521 #else
522 brp_errcode brp_DHWCtrl_UsbHostTransferOut(brp_DHWCtrl_UsbHostTransferOut_t params);
523 #endif
524 typedef struct {
525  brp_protocol protocol;
526  unsigned Index;
527  unsigned Addr;
528  unsigned Ep;
529 } brp_DHWCtrl_UsbHostTransferCancel_t;
539 #ifdef BRP_SUPPORT_LEGACY_METHODS
540 brp_errcode brp_DHWCtrl_UsbHostTransferCancel(brp_protocol protocol, unsigned _input_Index, unsigned _input_Addr, unsigned _input_Ep);
541 #else
542 brp_errcode brp_DHWCtrl_UsbHostTransferCancel(brp_DHWCtrl_UsbHostTransferCancel_t params);
543 #endif
544 typedef struct {
545  brp_protocol protocol;
546  unsigned Index;
547  bool Enable;
548 } brp_DHWCtrl_UsbHostSofControl_t;
557 #ifdef BRP_SUPPORT_LEGACY_METHODS
558 brp_errcode brp_DHWCtrl_UsbHostSofControl(brp_protocol protocol, unsigned _input_Index, bool _input_Enable);
559 #else
560 brp_errcode brp_DHWCtrl_UsbHostSofControl(brp_DHWCtrl_UsbHostSofControl_t params);
561 #endif
562 typedef struct {
563  brp_protocol protocol;
564  unsigned Index;
565  unsigned Sector;
566  unsigned Count;
567  brp_buf* Data;
568  size_t* Data_len;
569  brp_mempool *mempool;
570 } brp_DHWCtrl_FlashRead_t;
583 #ifdef BRP_SUPPORT_LEGACY_METHODS
584 brp_errcode brp_DHWCtrl_FlashRead(brp_protocol protocol, unsigned _input_Index, unsigned _input_Sector, unsigned _input_Count, brp_buf* Data, size_t* Data_len, brp_mempool *mempool);
585 #else
586 brp_errcode brp_DHWCtrl_FlashRead(brp_DHWCtrl_FlashRead_t params);
587 #endif
588 typedef struct {
589  brp_protocol protocol;
590  unsigned Index;
591  unsigned Sector;
592  brp_buf Data;
593  size_t Data_len;
594 } brp_DHWCtrl_FlashWrite_t;
605 #ifdef BRP_SUPPORT_LEGACY_METHODS
606 brp_errcode brp_DHWCtrl_FlashWrite(brp_protocol protocol, unsigned _input_Index, unsigned _input_Sector, brp_buf _input_Data, size_t _input_Data_len);
607 #else
608 brp_errcode brp_DHWCtrl_FlashWrite(brp_DHWCtrl_FlashWrite_t params);
609 #endif
610 typedef struct {
611  brp_protocol protocol;
612  unsigned Index;
613  unsigned Sector;
614  unsigned Count;
615 } brp_DHWCtrl_FlashErase_t;
625 #ifdef BRP_SUPPORT_LEGACY_METHODS
626 brp_errcode brp_DHWCtrl_FlashErase(brp_protocol protocol, unsigned _input_Index, unsigned _input_Sector, unsigned _input_Count);
627 #else
628 brp_errcode brp_DHWCtrl_FlashErase(brp_DHWCtrl_FlashErase_t params);
629 #endif
630 typedef struct {
631  brp_protocol protocol;
632  brp_DHWCtrl_ListPeripherals_Entries_Entry** Entries;
633  size_t* Entries_len;
634  brp_mempool *mempool;
635 } brp_DHWCtrl_ListPeripherals_t;
645 #ifdef BRP_SUPPORT_LEGACY_METHODS
646 brp_errcode brp_DHWCtrl_ListPeripherals(brp_protocol protocol, brp_DHWCtrl_ListPeripherals_Entries_Entry** Entries, size_t* Entries_len, brp_mempool *mempool);
647 #else
648 brp_errcode brp_DHWCtrl_ListPeripherals(brp_DHWCtrl_ListPeripherals_t params);
649 #endif
650 #endif // BALTECH_SDK_INTERNAL
651 #endif
652 
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