Mercurial > louis > kiibohd-controller
view Output/pjrcUSB/output_com.h @ 449:45feb80a2ad1
Major USB update, fixes most (if not all) known issues
USB - General
- Refactored descriptors
- Enabled/Disable USB endpoints
- Added debug flags for special features
- Code cleanup
- Interface count calculation based off of enabled endpoints
- Delayed wTotalLength calculation to simplify descriptor offsets
- Re-ordered endpoints and interfaces
- Added more debug output
- Added usbInitTime to show how long keyboard initialization took
(Useful when debugging bad init sequences)
- Added function for usb_resume() which takes care of the resume sequence
* Resume is now only called if packets are starting to timeout
USB - Special Options
- Added enableDeviceRestartOnUSBTimeout
* A last resort hammer for bad USB Chipsets/OSs, don't use if you can help it
* Disabled
- Added enableUSBResume
* Enables host resume wake-up signalling, required to wake a computer from sleep
* Enabled
- Added enableUSBLowPowerNegotiation
* Enables power negotiation hack
* Required to use firmware with an IPad and other hard-limit low-power USB hosts
* Hasn't been tested with the recent changes
* Disabled
- Added enableUSBSuspend
* Enables power down events on host USB bus suspend
* Enabled
USB - Keyboard
- Attempted to cleanup HID SET_REPORT
* Works much better
* Still has an issue under Linux which generates *a lot* of NAKs (initializes quickly regardless)
+ Not present on other keyboards
+ SETUP -> OUT -> IN : This sequence is the problem
+ Specifically during the OUT phase
- Enabled
USB - CDC Virtual Serial Port
- Code cleanup
- Added convenience struct USBCDCLineCoding for easier debugging
- Attempted to cleanup CDC_SET_LING_CODING
* Works much better
* Still has an issue under Linux which generates *a lot* of NAKs (initializes quickly regardless)
+ SETUP -> OUT -> IN : This sequence is the problem
+ Specifically during the OUT phase
+ Likely the same issues as HID SET_REPORT
- Enabled
USB - Mouse
- Enabled
USB - Joystick
- Disabled
USB - RawIO
- Initial code, API not used yet
- Disabled
DFU
- Updated load script, now faster
author | Jacob Alexander <haata@kiibohd.com> |
---|---|
date | Tue, 31 May 2016 00:19:45 -0700 |
parents | 56237ba5da6f |
children |
line wrap: on
line source
/* Copyright (C) 2013-2016 by Jacob Alexander * * 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. */ #pragma once // ----- Includes ----- // Compiler Includes #include <stdint.h> // Local Includes #include <buildvars.h> // Defines USB Parameters, partially generated by CMake // ----- Defines ----- // Max size of key buffer needed for NKRO // Boot mode uses only the first 6 bytes #define USB_NKRO_BITFIELD_SIZE_KEYS 27 #define USB_BOOT_MAX_KEYS 6 // ----- Enumerations ----- // USB NKRO state transitions (indicates which Report ID's need refreshing) // Boot mode just checks if any keys were changed (as everything is sent every time) typedef enum USBKeyChangeState { USBKeyChangeState_None = 0x00, USBKeyChangeState_Modifiers = 0x01, USBKeyChangeState_MainKeys = 0x02, USBKeyChangeState_SecondaryKeys = 0x04, USBKeyChangeState_TertiaryKeys = 0x08, USBKeyChangeState_QuartiaryKeys = 0x10, USBKeyChangeState_System = 0x20, USBKeyChangeState_Consumer = 0x40, USBKeyChangeState_All = 0x7F, } USBKeyChangeState; // Allows for selective USB descriptor pushes // However, in most cases everything is updated for each packet push typedef enum USBMouseChangeState { USBMouseChangeState_None = 0x00, USBMouseChangeState_Buttons = 0x01, USBMouseChangeState_Relative = 0x02, USBMouseChangeState_All = 0x03, } USBMouseChangeState; // ----- Variables ----- // Variables used to communciate to the output module // XXX Even if the output module is not USB, this is internally understood keymapping scheme extern uint8_t USBKeys_Modifiers; extern uint8_t USBKeys_Keys[USB_NKRO_BITFIELD_SIZE_KEYS]; extern uint8_t USBKeys_Sent; extern volatile uint8_t USBKeys_LEDs; extern uint8_t USBKeys_SysCtrl; // 1KRO container for System Control HID table extern uint16_t USBKeys_ConsCtrl; // 1KRO container for Consumer Control HID table extern volatile uint8_t USBKeys_Protocol; // 0 - Boot Mode, 1 - NKRO Mode extern volatile uint16_t USBMouse_Buttons; // Bitmask for mouse buttons extern volatile uint16_t USBMouse_Relative_x; extern volatile uint16_t USBMouse_Relative_y; // Keeps track of the idle timeout refresh (used on Mac OSX) extern uint8_t USBKeys_Idle_Config; extern uint32_t USBKeys_Idle_Expiry; extern uint8_t USBKeys_Idle_Count; // AVR only extern USBKeyChangeState USBKeys_Changed; extern USBMouseChangeState USBMouse_Changed; extern volatile uint8_t Output_Available; // 0 - Output module not fully functional, 1 - Output module working extern uint8_t Output_DebugMode; // 0 - Debug disabled, 1 - Debug enabled extern uint16_t Output_ExtCurrent_Available; // mA - Set by outside module if not using USB (i.e. Interconnect) extern volatile uint32_t USBInit_TimeStart; // Timetamp when usb_init was triggered extern volatile uint32_t USBInit_TimeEnd; // Timetamp since last call to the Configuration endpoint extern volatile uint16_t USBInit_Ticks; // Number of times the end time has been updated // ----- Functions ----- void Output_setup(); void Output_send(); void Output_flushBuffers(); void Output_firmwareReload(); void Output_softReset(); // Relies on USB serial module unsigned int Output_availablechar(); // Returns the total mA available (total, if used in a chain, each device will have to use a slice of it) unsigned int Output_current_available(); void Output_update_external_current( unsigned int current ); void Output_update_usb_current( unsigned int current ); int Output_getchar(); int Output_putchar( char c ); int Output_putstr( char* str );