ergodox-firmware/src/keyboard/controller.h

160 lines
4.9 KiB
C
Raw Normal View History

/* ----------------------------------------------------------------------------
* ergoDOX : controller specific exports
* ----------------------------------------------------------------------------
* Copyright (c) 2012 Ben Blazak <benblazak.dev@gmail.com>
* Released under The MIT License (MIT) (see "license.md")
* Project located at <https://github.com/benblazak/ergodox-firmware>
* ------------------------------------------------------------------------- */
2016-06-11 22:19:48 +02:00
#pragma once
2016-06-13 06:25:18 +02:00
#define USB_DEBUG_HID
2016-06-14 01:29:08 +02:00
#include <stdarg.h>
2016-06-11 22:19:48 +02:00
#include <stdbool.h>
#include <stdint.h>
2016-06-14 01:29:08 +02:00
#include <stdio.h>
#include <avr/io.h>
2016-06-12 04:34:29 +02:00
#include <avr/interrupt.h>
#include <avr/pgmspace.h>
2016-06-12 00:06:09 +02:00
#include <util/delay.h>
2016-06-11 23:15:38 +02:00
#include <util/twi.h>
2016-06-12 02:00:39 +02:00
// --------------------------------------------------------------------
/*
* DRIVE_ROWS and DRIVE_COLUMNS
* - Select which pins will drive (alternate between hi-Z and drive
* low) and which will be inputs
*
* Notes
* - You must set exactly one of each 'TEENSY' macro, and of each
* 'MCP23018' macro
* - If you are using internal diodes (inside the key switches)... then
* i don't know what to tell you. You will set one chip to drive
* rows, and the other to drive columns, but i don't have a key
* switch to check which at the moment, and i couldn't seem to find
* it online.
* - If the diode cathode is towards the square solder pad, set
* #define TEENSY__DRIVE_COLUMNS 1
* #define MCP23018__DRIVE_COLUMNS 1
* - If the diode cathode is towards the circular solder pad, set
* #define TEENSY__DRIVE_ROWS 1
* #define MCP23018__DRIVE_ROWS 1
*/
2016-06-12 04:08:50 +02:00
#define TEENSY__DRIVE_ROWS 0
#define MCP23018__DRIVE_ROWS 0
#define TEENSY__DRIVE_COLUMNS 1
#define MCP23018__DRIVE_COLUMNS 1
2016-06-12 02:00:39 +02:00
2016-06-12 04:08:50 +02:00
#define KB_ROWS 6 // must match real life
#define KB_COLUMNS 14 // must match real life
2016-06-11 22:19:48 +02:00
// --------------------------------------------------------------------
2016-06-11 22:19:48 +02:00
uint8_t kb_init(void);
uint8_t kb_update_matrix(bool matrix[KB_ROWS][KB_COLUMNS]);
2016-06-11 23:15:38 +02:00
// --------------------------------------------------------------------
#define MCP23018_TWI_ADDRESS 0b0100000
uint8_t mcp23018_init(void);
uint8_t mcp23018_update_matrix( bool matrix[KB_ROWS][KB_COLUMNS] );
// --------------------------------------------------------------------
uint8_t teensy_init(void);
uint8_t teensy_update_matrix( bool matrix[KB_ROWS][KB_COLUMNS] );
// --------------------------------------------------------------------
2016-06-11 23:27:17 +02:00
#define TWI_FREQ 400000
void twi_init (void);
uint8_t twi_start (void);
void twi_stop (void);
uint8_t twi_send (uint8_t data);
uint8_t twi_read (uint8_t * data);
2016-06-12 00:06:09 +02:00
// --------------------------------------------------------------------
2016-06-12 04:08:50 +02:00
void usb_init(void); // initialize everything
uint8_t usb_configured(void); // is the USB port configured
2016-06-12 00:06:09 +02:00
int8_t usb_keyboard_send(void);
extern uint8_t keyboard_modifier_keys;
extern uint8_t keyboard_keys[6];
extern uint16_t consumer_key;
// Everything below this point is only intended for usb_serial.c
2016-06-12 04:08:50 +02:00
#define EP_TYPE_CONTROL 0x00
#define EP_TYPE_BULK_IN 0x81
#define EP_TYPE_BULK_OUT 0x80
#define EP_TYPE_INTERRUPT_IN 0xC1
#define EP_TYPE_INTERRUPT_OUT 0xC0
#define EP_TYPE_ISOCHRONOUS_IN 0x41
#define EP_TYPE_ISOCHRONOUS_OUT 0x40
2016-06-12 00:06:09 +02:00
2016-06-12 04:08:50 +02:00
#define EP_SINGLE_BUFFER 0x02
#define EP_DOUBLE_BUFFER 0x06
2016-06-12 00:06:09 +02:00
2016-06-12 04:08:50 +02:00
#define EP_SIZE(s) ((s) == 64 ? 0x30 : \
((s) == 32 ? 0x20 : \
((s) == 16 ? 0x10 : \
0x00)))
2016-06-12 00:06:09 +02:00
2016-06-12 04:08:50 +02:00
#define MAX_ENDPOINT 4
2016-06-12 00:06:09 +02:00
#define LSB(n) (n & 255)
#define MSB(n) ((n >> 8) & 255)
2016-06-12 04:08:50 +02:00
#define HW_CONFIG() (UHWCON = 0x01)
#define PLL_CONFIG() (PLLCSR = 0x12)
#define USB_CONFIG() (USBCON = ((1<<USBE)|(1<<OTGPADE)))
#define USB_FREEZE() (USBCON = ((1<<USBE)|(1<<FRZCLK)))
2016-06-12 00:06:09 +02:00
// standard control endpoint request types
2016-06-12 04:08:50 +02:00
#define GET_STATUS 0
#define CLEAR_FEATURE 1
#define SET_FEATURE 3
#define SET_ADDRESS 5
#define GET_DESCRIPTOR 6
#define GET_CONFIGURATION 8
#define SET_CONFIGURATION 9
#define GET_INTERFACE 10
#define SET_INTERFACE 11
2016-06-12 00:06:09 +02:00
// HID (human interface device)
2016-06-12 04:08:50 +02:00
#define HID_GET_REPORT 1
#define HID_GET_IDLE 2
#define HID_GET_PROTOCOL 3
#define HID_SET_REPORT 9
#define HID_SET_IDLE 10
#define HID_SET_PROTOCOL 11
2016-06-12 00:06:09 +02:00
// CDC (communication class device)
2016-06-12 04:08:50 +02:00
#define CDC_SET_LINE_CODING 0x20
#define CDC_GET_LINE_CODING 0x21
2016-06-12 00:06:09 +02:00
#define CDC_SET_CONTROL_LINE_STATE 0x22
2016-06-12 02:00:39 +02:00
// -----------------------------------------------------------------
// debug
// -----------------------------------------------------------------
extern volatile uint8_t debug_flush_timer;
2016-06-14 02:49:07 +02:00
void usb_debug_free_memory(void);
2016-06-14 01:29:08 +02:00
void usb_debug_print(const char *s);
void usb_debug_printf(const char *fmt, ...);
2016-06-14 02:49:07 +02:00
int8_t usb_debug_putchar(char c);
void usb_debug_flush_output(void);
#ifdef KBD_DEBUG
#define debug_print(s) usb_debug_print(PSTR(s))
#define debug_printf(s, args...) usb_debug_printf(PSTR(s), args)
#else
#define debug_print(s)
#define debug_printf(...)
#endif