Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
tusb_config.h
1/*
2 * The MIT License (MIT)
3 *
4 * Copyright (c) 2022 Nathaniel Brough
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 *
24 */
25
26#ifndef _TUSB_CONFIG_H_
27#define _TUSB_CONFIG_H_
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33//--------------------------------------------------------------------+
34// Board Specific Configuration
35//--------------------------------------------------------------------+
36
37// RHPort number used for device can be defined by board.mk, default to port 0
38#ifndef BOARD_TUD_RHPORT
39#define BOARD_TUD_RHPORT 0
40#endif
41
42// RHPort max operational speed can defined by board.mk
43#ifndef BOARD_TUD_MAX_SPEED
44#define BOARD_TUD_MAX_SPEED OPT_MODE_DEFAULT_SPEED
45#endif
46
47//--------------------------------------------------------------------
48// Common Configuration
49//--------------------------------------------------------------------
50
51// defined by compiler flags for flexibility
52#ifndef CFG_TUSB_MCU
53#error CFG_TUSB_MCU must be defined
54#endif
55
56#ifndef CFG_TUSB_OS
57#define CFG_TUSB_OS OPT_OS_FREERTOS
58#endif
59
60#ifndef CFG_TUSB_DEBUG
61#define CFG_TUSB_DEBUG 0
62#endif
63
64// Enable Device stack
65#define CFG_TUD_ENABLED 1
66
67// Default is max speed that hardware controller could support with on-chip PHY
68#define CFG_TUD_MAX_SPEED BOARD_TUD_MAX_SPEED
69
70/* USB DMA on some MCUs can only access a specific SRAM region with restriction
71 * on alignment. Tinyusb use follows macros to declare transferring memory so
72 * that they can be put into those specific section. e.g
73 * - CFG_TUSB_MEM SECTION : __attribute__ (( section(".usb_ram") ))
74 * - CFG_TUSB_MEM_ALIGN : __attribute__ ((aligned(4)))
75 */
76#ifndef CFG_TUSB_MEM_SECTION
77#define CFG_TUSB_MEM_SECTION
78#endif
79
80#ifndef CFG_TUSB_MEM_ALIGN
81#define CFG_TUSB_MEM_ALIGN __attribute__((aligned(4)))
82#endif
83
84//--------------------------------------------------------------------
85// DEVICE CONFIGURATION
86//--------------------------------------------------------------------
87
88#ifndef CFG_TUD_ENDPOINT0_SIZE
89#define CFG_TUD_ENDPOINT0_SIZE 64
90#endif
91
92//------------- CLASS -------------//
93#define CFG_TUD_CDC 1
94#define CFG_TUD_MSC 0
95#define CFG_TUD_HID 0
96#define CFG_TUD_MIDI 0
97#define CFG_TUD_VENDOR 0
98
99// CDC FIFO size of TX and RX
100#define CFG_TUD_CDC_RX_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64)
101#define CFG_TUD_CDC_TX_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64)
102
103// CDC Endpoint transfer buffer size, more is faster
104#define CFG_TUD_CDC_EP_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64)
105
106// MSC Buffer size of Device Mass storage
107#define CFG_TUD_MSC_EP_BUFSIZE 512
108
109#ifdef __cplusplus
110}
111#endif
112
113#endif /* _TUSB_CONFIG_H_ */