wire-protocol-constants.h 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. /*
  2. * This file is taken from the KeyboardioScanner module:
  3. * https://github.com/keyboardio/KeyboardioScanner/blob/master/wire-protocol-constants.h
  4. *
  5. * Copyright (C) 2015-2018 Keyboard.io, Inc
  6. *
  7. * Permission is hereby granted, free of charge, to any person obtaining a copy
  8. * of this software and associated documentation files (the "Software"), to deal
  9. * in the Software without restriction, including without limitation the rights
  10. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11. * copies of the Software, and to permit persons to whom the Software is
  12. * furnished to do so, subject to the following conditions:
  13. *
  14. * The above copyright notice and this permission notice shall be included in all
  15. * copies or substantial portions of the Software.
  16. *
  17. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23. * SOFTWARE.
  24. */
  25. #pragma once
  26. #define TWI_CMD_NONE 0x00
  27. #define TWI_CMD_VERSION 0x01
  28. #define TWI_CMD_KEYSCAN_INTERVAL 0x02
  29. #define TWI_CMD_LED_SET_ALL_TO 0x03
  30. #define TWI_CMD_LED_SET_ONE_TO 0x04
  31. #define TWI_CMD_COLS_USE_PULLUPS 0x05
  32. #define TWI_CMD_LED_SPI_FREQUENCY 0x06
  33. #define LED_SPI_FREQUENCY_4MHZ 0x07
  34. #define LED_SPI_FREQUENCY_2MHZ 0x06
  35. #define LED_SPI_FREQUENCY_1MHZ 0x05
  36. #define LED_SPI_FREQUENCY_512KHZ 0x04
  37. #define LED_SPI_FREQUENCY_256KHZ 0x03
  38. #define LED_SPI_FREQUENCY_128KHZ 0x02
  39. #define LED_SPI_FREQUENCY_64KHZ 0x01
  40. #define LED_SPI_OFF 0x00
  41. // 512KHZ seems to be the sweet spot in early testing
  42. // so make it the default
  43. #define LED_SPI_FREQUENCY_DEFAULT LED_SPI_FREQUENCY_512KHZ
  44. #define TWI_CMD_LED_BASE 0x80
  45. #define TWI_REPLY_NONE 0x00
  46. #define TWI_REPLY_KEYDATA 0x01