Created
January 5, 2024 13:35
-
-
Save sonnny/69a56cb1e59f5fc2d52d5d3d4ba35146 to your computer and use it in GitHub Desktop.
minimal pico usb keyboard, no matrix switches just plain switches wired to pico gpio pin, tested and works with reduced number of gpio pin for testing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| simple demo of usb keyboard | |
| no matrix keyboard, 1 key per pico gpio | |
| source from https://github.com/PhilboBaggins/pico-keys | |
| tested good with switches | |
| /************************ | |
| * PicoKeysExample.c | |
| ***********************/ | |
| #include <ctype.h> | |
| #include <stdio.h> | |
| #include <stdlib.h> | |
| #include <string.h> | |
| #include "bsp/board.h" | |
| #include "hardware/uart.h" | |
| #include "pico/stdlib.h" | |
| #include "tusb.h" | |
| #include "buttons.h" | |
| #include "usb_descriptors.h" | |
| // Map buttons to key codes - These will be send when the button is pressed | |
| uint8_t BUTTON_KEY_MAP[NUM_BUTTONS] = | |
| { | |
| HID_KEY_F21, HID_KEY_B, HID_KEY_C, | |
| HID_KEY_F22, HID_KEY_E, HID_KEY_F, | |
| HID_KEY_F23, HID_KEY_H, HID_KEY_I, | |
| HID_KEY_F24, HID_KEY_K, HID_KEY_L, | |
| #if BOAD_MAJOR_VERSION == 1 | |
| HID_KEY_M, HID_KEY_N, HID_KEY_O, | |
| #endif | |
| }; | |
| void hid_task(void); | |
| //--------------------------------------------------------------------+ | |
| // Main | |
| //--------------------------------------------------------------------+ | |
| int main(void) | |
| { | |
| board_init(); | |
| tusb_init(); | |
| buttons_init(); | |
| while (true) | |
| { | |
| tud_task(); // tinyusb device task | |
| hid_task(); | |
| } | |
| return 0; | |
| } | |
| //--------------------------------------------------------------------+ | |
| // Device callbacks | |
| //--------------------------------------------------------------------+ | |
| // Invoked when device is mounted | |
| void tud_mount_cb(void) | |
| { | |
| } | |
| // Invoked when device is unmounted | |
| void tud_umount_cb(void) | |
| { | |
| } | |
| // Invoked when usb bus is suspended | |
| // remote_wakeup_en : if host allow us to perform remote wakeup | |
| // Within 7ms, device must draw an average of current less than 2.5 mA from bus | |
| void tud_suspend_cb(bool remote_wakeup_en) | |
| { | |
| (void)remote_wakeup_en; | |
| } | |
| // Invoked when usb bus is resumed | |
| void tud_resume_cb(void) | |
| { | |
| } | |
| //--------------------------------------------------------------------+ | |
| // USB HID | |
| //--------------------------------------------------------------------+ | |
| #define NUM_SIMULTANEOUS_USB_KEY_CODES 6 | |
| bool addKey(uint8_t existingKeycodes[NUM_SIMULTANEOUS_USB_KEY_CODES], uint8_t newKeyCode) | |
| { | |
| // USB HID allows for 6 keys pressed at one time. So effectively there are 6 slots we could put out key code into | |
| // Go through each slot, check if it's empty and if so, put our key code in | |
| for (int idx = 0; idx < NUM_SIMULTANEOUS_USB_KEY_CODES; idx++) | |
| { | |
| if (existingKeycodes[idx] == 0) | |
| { | |
| existingKeycodes[idx] = newKeyCode; | |
| return true; | |
| } | |
| } | |
| // All slots full so could not add this new keycode | |
| return false; | |
| } | |
| // Every 10ms, check all buttons and send a keyboard report | |
| // for any button (up tp 6 total) that are pressed or held | |
| void hid_task(void) | |
| { | |
| // Poll every 10ms | |
| const uint32_t interval_ms = 10; | |
| static uint32_t start_ms = 0; | |
| if (board_millis() - start_ms < interval_ms) | |
| return; // not enough time | |
| start_ms += interval_ms; | |
| static uint8_t prevSentKeycodes[6] = {0}; | |
| uint8_t keycodes[6] = {0}; | |
| // Check each button | |
| for (int buttonIdx = 0; buttonIdx < NUM_BUTTONS; buttonIdx++) | |
| { | |
| enum BUTTON_STATE state = buttonRead(buttonIdx); | |
| switch (state) | |
| { | |
| case BUTTON_NOT_PRESSED: | |
| break; | |
| case BUTTON_PRESSED: | |
| addKey(keycodes, BUTTON_KEY_MAP[buttonIdx]); | |
| break; | |
| case BUTTON_HELD_PRESSED: | |
| addKey(keycodes, BUTTON_KEY_MAP[buttonIdx]); | |
| break; | |
| case BUTTON_RELEASED: | |
| break; | |
| default: | |
| break; | |
| } | |
| } | |
| // Check if any new key codes need to be send | |
| bool newKeysToSend = false; | |
| for (int idx = 0; idx < NUM_SIMULTANEOUS_USB_KEY_CODES; idx++) | |
| { | |
| if (keycodes[idx] != prevSentKeycodes[idx]) | |
| { | |
| newKeysToSend = true; | |
| prevSentKeycodes[idx] = keycodes[idx]; | |
| } | |
| } | |
| if (newKeysToSend) | |
| { | |
| tud_hid_keyboard_report(REPORT_ID_KEYBOARD, 0, keycodes); | |
| } | |
| } | |
| /********* I commented this function out because I'm getting compiler error ********/ | |
| // Invoked when sent REPORT successfully to host | |
| // Application can use this to send the next report | |
| // Note: For composite reports, report[0] is report ID | |
| //void tud_hid_report_complete_cb(uint8_t instance, uint8_t const* report, uint8_t len) | |
| //{ | |
| // (void)instance; | |
| // (void)len; | |
| //} | |
| // Invoked when received GET_REPORT control request | |
| // Application must fill buffer report's content and return its length. | |
| // Return zero will cause the stack to STALL request | |
| uint16_t tud_hid_get_report_cb(uint8_t instance, uint8_t report_id, hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen) | |
| { | |
| (void)instance; | |
| (void)report_id; | |
| (void)report_type; | |
| (void)buffer; | |
| (void)reqlen; | |
| return 0; | |
| } | |
| // Invoked when received SET_REPORT control request or received data on OUT endpoint ( Report ID = 0, Type = 0 ) | |
| void tud_hid_set_report_cb(uint8_t instance, uint8_t report_id, hid_report_type_t report_type, uint8_t const* buffer, uint16_t bufsize) | |
| { | |
| (void)instance; | |
| (void)report_id; | |
| (void)report_type; | |
| (void)buffer; | |
| (void)bufsize; | |
| } | |
| /****************************** | |
| * buttons.h | |
| *****************************/ | |
| #ifndef _BUTTONS_H_ | |
| #define _BUTTONS_H_ | |
| #include <stdint.h> | |
| // Select your board version (only define one and comment the others out) | |
| //#define BOAD_MAJOR_VERSION 1 | |
| #define BOAD_MAJOR_VERSION 2 | |
| #if BOAD_MAJOR_VERSION == 1 | |
| #define NUM_BUTTONS 16 | |
| #elif BOAD_MAJOR_VERSION == 2 | |
| #define NUM_BUTTONS 12 | |
| #else | |
| #error Invalid board version selected | |
| #endif | |
| extern const int BUTTON_PINS[NUM_BUTTONS]; | |
| enum BUTTON_STATE | |
| { | |
| BUTTON_NOT_PRESSED = 0, | |
| BUTTON_PRESSED, | |
| BUTTON_HELD_PRESSED, | |
| BUTTON_RELEASED, | |
| }; | |
| // Function prototypes | |
| void buttons_init(); | |
| enum BUTTON_STATE buttonRead(int buttonIdx); | |
| #endif // _BUTTONS_H_ | |
| /******************************** | |
| * buttons.c | |
| *******************************/ | |
| #include <buttons.h> | |
| #include "hardware/gpio.h" | |
| #include <stdbool.h> | |
| #if BOAD_MAJOR_VERSION == 1 | |
| const int BUTTON_PINS[NUM_BUTTONS] = {16,17,18};//{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; | |
| #elif BOAD_MAJOR_VERSION == 2 | |
| const int BUTTON_PINS[NUM_BUTTONS] = {16,17,18};//{ 27, 28, 5, 21, 20, 11, 18, 16, 13, 17, 15, 14 }; | |
| #else | |
| #error Invalid board version selected | |
| #endif | |
| void buttons_init() | |
| { | |
| for (int buttonIdx = 0; buttonIdx < NUM_BUTTONS; buttonIdx++) | |
| { | |
| const int gpioNumber = BUTTON_PINS[buttonIdx]; | |
| gpio_init(gpioNumber); | |
| gpio_set_dir(gpioNumber, GPIO_IN); | |
| gpio_pull_up(gpioNumber); | |
| } | |
| } | |
| enum BUTTON_STATE buttonRead(int buttonIdx) | |
| { | |
| static bool prevBtnStates[NUM_BUTTONS] = { false }; | |
| const int gpioNumber = BUTTON_PINS[buttonIdx]; | |
| const bool prevState = prevBtnStates[buttonIdx]; | |
| const bool currentState = gpio_get(gpioNumber); | |
| prevBtnStates[buttonIdx] = currentState; | |
| if (!prevState && currentState) | |
| { | |
| return BUTTON_RELEASED; | |
| } | |
| else if (prevState && !currentState) | |
| { | |
| return BUTTON_PRESSED; | |
| } | |
| else if (!prevState && !currentState) | |
| { | |
| return BUTTON_HELD_PRESSED; | |
| } | |
| else | |
| { | |
| return BUTTON_NOT_PRESSED; | |
| } | |
| } | |
| /******************************* | |
| * CMakeLists.txt | |
| *****************************/ | |
| # Generated Cmake Pico project file | |
| cmake_minimum_required(VERSION 3.13) | |
| set(CMAKE_C_STANDARD 11) | |
| set(CMAKE_CXX_STANDARD 17) | |
| # Initialise pico_sdk from installed location | |
| # (note this can come from environment, CMake cache etc) | |
| #set(PICO_SDK_PATH "path/to/Pico/pico-sdk") | |
| set(PICO_BOARD pico CACHE STRING "Board type") | |
| # Pull in Raspberry Pi Pico SDK (must be before project) | |
| include(pico_sdk_import.cmake) | |
| if (PICO_SDK_VERSION_STRING VERSION_LESS "1.4.0") | |
| message(FATAL_ERROR "Raspberry Pi Pico SDK version 1.3.0 (or later) required. Your version is ${PICO_SDK_VERSION_STRING}") | |
| endif() | |
| project(PicoKeysExample C CXX ASM) | |
| # Initialise the Raspberry Pi Pico SDK | |
| pico_sdk_init() | |
| # Add executable. Default name is the project name, version 0.1 | |
| add_executable(PicoKeysExample | |
| PicoKeysExample.c | |
| usb_descriptors.c | |
| buttons.c | |
| ) | |
| pico_set_program_name(PicoKeysExample "PicoKeysExample") | |
| pico_set_program_version(PicoKeysExample "0.1") | |
| pico_enable_stdio_uart(PicoKeysExample 1) | |
| pico_enable_stdio_usb(PicoKeysExample 0) | |
| # Add the standard library to the build | |
| target_link_libraries(PicoKeysExample | |
| pico_stdlib) | |
| # Add the standard include files to the build | |
| target_include_directories(PicoKeysExample PRIVATE | |
| ${CMAKE_CURRENT_LIST_DIR} | |
| ${CMAKE_CURRENT_LIST_DIR}/.. # for our common lwipopts or any other standard includes, if required | |
| ) | |
| # Add any user requested libraries | |
| target_link_libraries(PicoKeysExample | |
| tinyusb_device | |
| tinyusb_board | |
| ) | |
| pico_add_extra_outputs(PicoKeysExample) | |
| /**************************** | |
| * usb_descriptors.h | |
| ***************************/ | |
| /* | |
| * The MIT License (MIT) | |
| * | |
| * Copyright (c) 2019 Ha Thach (tinyusb.org) | |
| * | |
| * Permission is hereby granted, free of charge, to any person obtaining a copy | |
| * of this software and associated documentation files (the "Software"), to deal | |
| * in the Software without restriction, including without limitation the rights | |
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| * copies of the Software, and to permit persons to whom the Software is | |
| * furnished to do so, subject to the following conditions: | |
| * | |
| * The above copyright notice and this permission notice shall be included in | |
| * all copies or substantial portions of the Software. | |
| * | |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
| * THE SOFTWARE. | |
| */ | |
| #ifndef USB_DESCRIPTORS_H_ | |
| #define USB_DESCRIPTORS_H_ | |
| enum | |
| { | |
| REPORT_ID_KEYBOARD = 1, | |
| REPORT_ID_MOUSE, | |
| REPORT_ID_CONSUMER_CONTROL, | |
| REPORT_ID_GAMEPAD, | |
| REPORT_ID_COUNT | |
| }; | |
| #endif /* USB_DESCRIPTORS_H_ */ | |
| /********************************** | |
| * usb_descriptors.c | |
| *********************************/ | |
| /* | |
| * The MIT License (MIT) | |
| * | |
| * Copyright (c) 2019 Ha Thach (tinyusb.org) | |
| * | |
| * Permission is hereby granted, free of charge, to any person obtaining a copy | |
| * of this software and associated documentation files (the "Software"), to deal | |
| * in the Software without restriction, including without limitation the rights | |
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| * copies of the Software, and to permit persons to whom the Software is | |
| * furnished to do so, subject to the following conditions: | |
| * | |
| * The above copyright notice and this permission notice shall be included in | |
| * all copies or substantial portions of the Software. | |
| * | |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
| * THE SOFTWARE. | |
| * | |
| */ | |
| #include "tusb.h" | |
| #include "usb_descriptors.h" | |
| /* A combination of interfaces must have a unique product id, since PC will save device driver after the first plug. | |
| * Same VID/PID with different interface e.g MSC (first), then CDC (later) will possibly cause system error on PC. | |
| * | |
| * Auto ProductID layout's Bitmap: | |
| * [MSB] MIDI | HID | MSC | CDC [LSB] | |
| */ | |
| #define _PID_MAP(itf, n) ( (CFG_TUD_##itf) << (n) ) | |
| #define USB_PID (0x4000 | _PID_MAP(CDC, 0) | _PID_MAP(MSC, 1) | _PID_MAP(HID, 2) | \ | |
| _PID_MAP(MIDI, 3) | _PID_MAP(VENDOR, 4) ) | |
| #define USB_VID 0xCafe | |
| #define USB_BCD 0x0200 | |
| //--------------------------------------------------------------------+ | |
| // Device Descriptors | |
| //--------------------------------------------------------------------+ | |
| tusb_desc_device_t const desc_device = | |
| { | |
| .bLength = sizeof(tusb_desc_device_t), | |
| .bDescriptorType = TUSB_DESC_DEVICE, | |
| .bcdUSB = USB_BCD, | |
| .bDeviceClass = 0x00, | |
| .bDeviceSubClass = 0x00, | |
| .bDeviceProtocol = 0x00, | |
| .bMaxPacketSize0 = CFG_TUD_ENDPOINT0_SIZE, | |
| .idVendor = USB_VID, | |
| .idProduct = USB_PID, | |
| .bcdDevice = 0x0100, | |
| .iManufacturer = 0x01, | |
| .iProduct = 0x02, | |
| .iSerialNumber = 0x03, | |
| .bNumConfigurations = 0x01 | |
| }; | |
| // Invoked when received GET DEVICE DESCRIPTOR | |
| // Application return pointer to descriptor | |
| uint8_t const * tud_descriptor_device_cb(void) | |
| { | |
| return (uint8_t const *) &desc_device; | |
| } | |
| //--------------------------------------------------------------------+ | |
| // HID Report Descriptor | |
| //--------------------------------------------------------------------+ | |
| uint8_t const desc_hid_report[] = | |
| { | |
| TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(REPORT_ID_KEYBOARD )), | |
| TUD_HID_REPORT_DESC_MOUSE ( HID_REPORT_ID(REPORT_ID_MOUSE )), | |
| TUD_HID_REPORT_DESC_CONSUMER( HID_REPORT_ID(REPORT_ID_CONSUMER_CONTROL )), | |
| TUD_HID_REPORT_DESC_GAMEPAD ( HID_REPORT_ID(REPORT_ID_GAMEPAD )) | |
| }; | |
| // Invoked when received GET HID REPORT DESCRIPTOR | |
| // Application return pointer to descriptor | |
| // Descriptor contents must exist long enough for transfer to complete | |
| uint8_t const * tud_hid_descriptor_report_cb(uint8_t instance) | |
| { | |
| (void) instance; | |
| return desc_hid_report; | |
| } | |
| //--------------------------------------------------------------------+ | |
| // Configuration Descriptor | |
| //--------------------------------------------------------------------+ | |
| enum | |
| { | |
| ITF_NUM_HID, | |
| ITF_NUM_TOTAL | |
| }; | |
| #define CONFIG_TOTAL_LEN (TUD_CONFIG_DESC_LEN + TUD_HID_DESC_LEN) | |
| #define EPNUM_HID 0x81 | |
| uint8_t const desc_configuration[] = | |
| { | |
| // Config number, interface count, string index, total length, attribute, power in mA | |
| TUD_CONFIG_DESCRIPTOR(1, ITF_NUM_TOTAL, 0, CONFIG_TOTAL_LEN, TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP, 100), | |
| // Interface number, string index, protocol, report descriptor len, EP In address, size & polling interval | |
| TUD_HID_DESCRIPTOR(ITF_NUM_HID, 0, HID_ITF_PROTOCOL_NONE, sizeof(desc_hid_report), EPNUM_HID, CFG_TUD_HID_EP_BUFSIZE, 5) | |
| }; | |
| #if TUD_OPT_HIGH_SPEED | |
| // Per USB specs: high speed capable device must report device_qualifier and other_speed_configuration | |
| // other speed configuration | |
| uint8_t desc_other_speed_config[CONFIG_TOTAL_LEN]; | |
| // device qualifier is mostly similar to device descriptor since we don't change configuration based on speed | |
| tusb_desc_device_qualifier_t const desc_device_qualifier = | |
| { | |
| .bLength = sizeof(tusb_desc_device_qualifier_t), | |
| .bDescriptorType = TUSB_DESC_DEVICE_QUALIFIER, | |
| .bcdUSB = USB_BCD, | |
| .bDeviceClass = 0x00, | |
| .bDeviceSubClass = 0x00, | |
| .bDeviceProtocol = 0x00, | |
| .bMaxPacketSize0 = CFG_TUD_ENDPOINT0_SIZE, | |
| .bNumConfigurations = 0x01, | |
| .bReserved = 0x00 | |
| }; | |
| // Invoked when received GET DEVICE QUALIFIER DESCRIPTOR request | |
| // Application return pointer to descriptor, whose contents must exist long enough for transfer to complete. | |
| // device_qualifier descriptor describes information about a high-speed capable device that would | |
| // change if the device were operating at the other speed. If not highspeed capable stall this request. | |
| uint8_t const* tud_descriptor_device_qualifier_cb(void) | |
| { | |
| return (uint8_t const*) &desc_device_qualifier; | |
| } | |
| // Invoked when received GET OTHER SEED CONFIGURATION DESCRIPTOR request | |
| // Application return pointer to descriptor, whose contents must exist long enough for transfer to complete | |
| // Configuration descriptor in the other speed e.g if high speed then this is for full speed and vice versa | |
| uint8_t const* tud_descriptor_other_speed_configuration_cb(uint8_t index) | |
| { | |
| (void) index; // for multiple configurations | |
| // other speed config is basically configuration with type = OHER_SPEED_CONFIG | |
| memcpy(desc_other_speed_config, desc_configuration, CONFIG_TOTAL_LEN); | |
| desc_other_speed_config[1] = TUSB_DESC_OTHER_SPEED_CONFIG; | |
| // this example use the same configuration for both high and full speed mode | |
| return desc_other_speed_config; | |
| } | |
| #endif // highspeed | |
| // Invoked when received GET CONFIGURATION DESCRIPTOR | |
| // Application return pointer to descriptor | |
| // Descriptor contents must exist long enough for transfer to complete | |
| uint8_t const * tud_descriptor_configuration_cb(uint8_t index) | |
| { | |
| (void) index; // for multiple configurations | |
| // This example use the same configuration for both high and full speed mode | |
| return desc_configuration; | |
| } | |
| //--------------------------------------------------------------------+ | |
| // String Descriptors | |
| //--------------------------------------------------------------------+ | |
| // array of pointer to string descriptors | |
| char const* string_desc_arr [] = | |
| { | |
| (const char[]) { 0x09, 0x04 }, // 0: is supported language is English (0x0409) | |
| "TinyUSB", // 1: Manufacturer | |
| "TinyUSB Device", // 2: Product | |
| "123456", // 3: Serials, should use chip ID | |
| }; | |
| static uint16_t _desc_str[32]; | |
| // Invoked when received GET STRING DESCRIPTOR request | |
| // Application return pointer to descriptor, whose contents must exist long enough for transfer to complete | |
| uint16_t const* tud_descriptor_string_cb(uint8_t index, uint16_t langid) | |
| { | |
| (void) langid; | |
| uint8_t chr_count; | |
| if ( index == 0) | |
| { | |
| memcpy(&_desc_str[1], string_desc_arr[0], 2); | |
| chr_count = 1; | |
| }else | |
| { | |
| // Note: the 0xEE index string is a Microsoft OS 1.0 Descriptors. | |
| // https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/microsoft-defined-usb-descriptors | |
| if ( !(index < sizeof(string_desc_arr)/sizeof(string_desc_arr[0])) ) return NULL; | |
| const char* str = string_desc_arr[index]; | |
| // Cap at max char | |
| chr_count = (uint8_t)strlen(str); | |
| if ( chr_count > 31 ) chr_count = 31; | |
| // Convert ASCII string into UTF-16 | |
| for(uint8_t i=0; i<chr_count; i++) | |
| { | |
| _desc_str[1+i] = str[i]; | |
| } | |
| } | |
| // first byte is length (including header), second byte is string type | |
| _desc_str[0] = (uint16_t)((TUSB_DESC_STRING << 8 ) | (2*chr_count + 2)); | |
| return _desc_str; | |
| } | |
| /************************************** | |
| * tusb_config.h | |
| ************************************/ | |
| /* | |
| * The MIT License (MIT) | |
| * | |
| * Copyright (c) 2019 Ha Thach (tinyusb.org) | |
| * | |
| * Permission is hereby granted, free of charge, to any person obtaining a copy | |
| * of this software and associated documentation files (the "Software"), to deal | |
| * in the Software without restriction, including without limitation the rights | |
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| * copies of the Software, and to permit persons to whom the Software is | |
| * furnished to do so, subject to the following conditions: | |
| * | |
| * The above copyright notice and this permission notice shall be included in | |
| * all copies or substantial portions of the Software. | |
| * | |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
| * THE SOFTWARE. | |
| * | |
| */ | |
| #ifndef _TUSB_CONFIG_H_ | |
| #define _TUSB_CONFIG_H_ | |
| #ifdef __cplusplus | |
| extern "C" { | |
| #endif | |
| //-------------------------------------------------------------------- | |
| // COMMON CONFIGURATION | |
| //-------------------------------------------------------------------- | |
| // defined by board.mk | |
| #ifndef CFG_TUSB_MCU | |
| #error CFG_TUSB_MCU must be defined | |
| #endif | |
| // RHPort number used for device can be defined by board.mk, default to port 0 | |
| #ifndef BOARD_DEVICE_RHPORT_NUM | |
| #define BOARD_DEVICE_RHPORT_NUM 0 | |
| #endif | |
| // RHPort max operational speed can defined by board.mk | |
| // Default to Highspeed for MCU with internal HighSpeed PHY (can be port specific), otherwise FullSpeed | |
| #ifndef BOARD_DEVICE_RHPORT_SPEED | |
| #if (CFG_TUSB_MCU == OPT_MCU_LPC18XX || CFG_TUSB_MCU == OPT_MCU_LPC43XX || CFG_TUSB_MCU == OPT_MCU_MIMXRT10XX || \ | |
| CFG_TUSB_MCU == OPT_MCU_NUC505 || CFG_TUSB_MCU == OPT_MCU_CXD56 || CFG_TUSB_MCU == OPT_MCU_SAMX7X) | |
| #define BOARD_DEVICE_RHPORT_SPEED OPT_MODE_HIGH_SPEED | |
| #else | |
| #define BOARD_DEVICE_RHPORT_SPEED OPT_MODE_FULL_SPEED | |
| #endif | |
| #endif | |
| // Device mode with rhport and speed defined by board.mk | |
| #if BOARD_DEVICE_RHPORT_NUM == 0 | |
| #define CFG_TUSB_RHPORT0_MODE (OPT_MODE_DEVICE | BOARD_DEVICE_RHPORT_SPEED) | |
| #elif BOARD_DEVICE_RHPORT_NUM == 1 | |
| #define CFG_TUSB_RHPORT1_MODE (OPT_MODE_DEVICE | BOARD_DEVICE_RHPORT_SPEED) | |
| #else | |
| #error "Incorrect RHPort configuration" | |
| #endif | |
| #ifndef CFG_TUSB_OS | |
| #define CFG_TUSB_OS OPT_OS_NONE | |
| #endif | |
| // CFG_TUSB_DEBUG is defined by compiler in DEBUG build | |
| // #define CFG_TUSB_DEBUG 0 | |
| /* USB DMA on some MCUs can only access a specific SRAM region with restriction on alignment. | |
| * Tinyusb use follows macros to declare transferring memory so that they can be put | |
| * into those specific section. | |
| * e.g | |
| * - CFG_TUSB_MEM SECTION : __attribute__ (( section(".usb_ram") )) | |
| * - CFG_TUSB_MEM_ALIGN : __attribute__ ((aligned(4))) | |
| */ | |
| #ifndef CFG_TUSB_MEM_SECTION | |
| #define CFG_TUSB_MEM_SECTION | |
| #endif | |
| #ifndef CFG_TUSB_MEM_ALIGN | |
| #define CFG_TUSB_MEM_ALIGN __attribute__ ((aligned(4))) | |
| #endif | |
| //-------------------------------------------------------------------- | |
| // DEVICE CONFIGURATION | |
| //-------------------------------------------------------------------- | |
| #ifndef CFG_TUD_ENDPOINT0_SIZE | |
| #define CFG_TUD_ENDPOINT0_SIZE 64 | |
| #endif | |
| //------------- CLASS -------------// | |
| #define CFG_TUD_HID 1 | |
| #define CFG_TUD_CDC 0 | |
| #define CFG_TUD_MSC 0 | |
| #define CFG_TUD_MIDI 0 | |
| #define CFG_TUD_VENDOR 0 | |
| // HID buffer size Should be sufficient to hold ID (if any) + Data | |
| #define CFG_TUD_HID_EP_BUFSIZE 16 | |
| #ifdef __cplusplus | |
| } | |
| #endif | |
| #endif /* _TUSB_CONFIG_H_ */ | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment