diff options
Diffstat (limited to 'tmk_core/protocol')
23 files changed, 106 insertions, 2703 deletions
| diff --git a/tmk_core/protocol/chibios.mk b/tmk_core/protocol/chibios.mk index a7f2d8e93d..8eaf5b10d2 100644 --- a/tmk_core/protocol/chibios.mk +++ b/tmk_core/protocol/chibios.mk @@ -15,7 +15,3 @@ VPATH += $(TMK_PATH)/$(CHIBIOS_DIR)/lufa_utils  OPT_DEFS += -DFIXED_CONTROL_ENDPOINT_SIZE=64  OPT_DEFS += -DFIXED_NUM_CONFIGURATIONS=1 - -ifeq ($(strip $(MIDI_ENABLE)), yes) -  include $(TMK_PATH)/protocol/midi.mk -endif diff --git a/tmk_core/protocol/chibios/usb_main.c b/tmk_core/protocol/chibios/usb_main.c index 62a11faff7..b14ca30c1a 100644 --- a/tmk_core/protocol/chibios/usb_main.c +++ b/tmk_core/protocol/chibios/usb_main.c @@ -69,19 +69,27 @@ uint8_t                keyboard_led_state                            = 0;  volatile uint16_t      keyboard_idle_count                           = 0;  static virtual_timer_t keyboard_idle_timer; -#if CH_KERNEL_MAJOR >= 7  static void keyboard_idle_timer_cb(struct ch_virtual_timer *, void *arg); -#elif CH_KERNEL_MAJOR <= 6 -static void keyboard_idle_timer_cb(void *arg); -#endif  report_keyboard_t keyboard_report_sent = {{0}}; -#ifdef MOUSE_ENABLE -report_mouse_t mouse_report_blank = {0}; -#endif /* MOUSE_ENABLE */ +report_mouse_t    mouse_report_sent    = {0}; + +union { +    uint8_t           report_id; +    report_keyboard_t keyboard;  #ifdef EXTRAKEY_ENABLE -uint8_t extra_report_blank[3] = {0}; -#endif /* EXTRAKEY_ENABLE */ +    report_extra_t extra; +#endif +#ifdef MOUSE_ENABLE +    report_mouse_t mouse; +#endif +#ifdef DIGITIZER_ENABLE +    report_digitizer_t digitizer; +#endif +#ifdef JOYSTICK_ENABLE +    report_joystick_t joystick; +#endif +} universal_report_blank = {0};  /* ---------------------------------------------------------   *            Descriptors and USB driver objects @@ -111,9 +119,10 @@ uint8_t extra_report_blank[3] = {0};  static const USBDescriptor *usb_get_descriptor_cb(USBDriver *usbp, uint8_t dtype, uint8_t dindex, uint16_t wIndex) {      (void)usbp;      static USBDescriptor desc; -    uint16_t             wValue = ((uint16_t)dtype << 8) | dindex; -    desc.ud_string              = NULL; -    desc.ud_size                = get_usb_descriptor(wValue, wIndex, (const void **const) & desc.ud_string); +    uint16_t             wValue  = ((uint16_t)dtype << 8) | dindex; +    uint16_t             wLength = ((uint16_t)usbp->setup[7] << 8) | usbp->setup[6]; +    desc.ud_string               = NULL; +    desc.ud_size                 = get_usb_descriptor(wValue, wIndex, wLength, (const void **const) & desc.ud_string);      if (desc.ud_string == NULL)          return NULL;      else @@ -585,7 +594,8 @@ static uint16_t get_hword(uint8_t *p) {   */  static uint8_t set_report_buf[2] __attribute__((aligned(4))); -static void    set_led_transfer_cb(USBDriver *usbp) { + +static void set_led_transfer_cb(USBDriver *usbp) {      if (usbp->setup[6] == 2) { /* LSB(wLength) */          uint8_t report_id = set_report_buf[0];          if ((report_id == REPORT_ID_KEYBOARD) || (report_id == REPORT_ID_NKRO)) { @@ -614,20 +624,38 @@ static bool usb_request_hook_cb(USBDriver *usbp) {                  switch (usbp->setup[1]) { /* bRequest */                      case HID_GET_REPORT:                          switch (usbp->setup[4]) { /* LSB(wIndex) (check MSB==0?) */ +#ifndef KEYBOARD_SHARED_EP                              case KEYBOARD_INTERFACE: -                                usbSetupTransfer(usbp, (uint8_t *)&keyboard_report_sent, sizeof(keyboard_report_sent), NULL); +                                usbSetupTransfer(usbp, (uint8_t *)&keyboard_report_sent, KEYBOARD_REPORT_SIZE, NULL);                                  return TRUE;                                  break; - +#endif  #if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)                              case MOUSE_INTERFACE: -                                usbSetupTransfer(usbp, (uint8_t *)&mouse_report_blank, sizeof(mouse_report_blank), NULL); +                                usbSetupTransfer(usbp, (uint8_t *)&mouse_report_sent, sizeof(mouse_report_sent), NULL);                                  return TRUE;                                  break;  #endif - +#ifdef SHARED_EP_ENABLE +                            case SHARED_INTERFACE: +#    ifdef KEYBOARD_SHARED_EP +                                if (usbp->setup[2] == REPORT_ID_KEYBOARD) { +                                    usbSetupTransfer(usbp, (uint8_t *)&keyboard_report_sent, KEYBOARD_REPORT_SIZE, NULL); +                                    return TRUE; +                                    break; +                                } +#    endif +#    ifdef MOUSE_SHARED_EP +                                if (usbp->setup[2] == REPORT_ID_MOUSE) { +                                    usbSetupTransfer(usbp, (uint8_t *)&mouse_report_sent, sizeof(mouse_report_sent), NULL); +                                    return TRUE; +                                    break; +                                } +#    endif +#endif /* SHARED_EP_ENABLE */                              default: -                                usbSetupTransfer(usbp, NULL, 0, NULL); +                                universal_report_blank.report_id = usbp->setup[2]; +                                usbSetupTransfer(usbp, (uint8_t *)&universal_report_blank, usbp->setup[6], NULL);                                  return TRUE;                                  break;                          } @@ -665,8 +693,7 @@ static bool usb_request_hook_cb(USBDriver *usbp) {                          if ((usbp->setup[4] == KEYBOARD_INTERFACE) && (usbp->setup[5] == 0)) { /* wIndex */                              keyboard_protocol = ((usbp->setup[2]) != 0x00);                    /* LSB(wValue) */  #ifdef NKRO_ENABLE -                            keymap_config.nkro = !!keyboard_protocol; -                            if (!keymap_config.nkro && keyboard_idle) { +                            if (!keyboard_protocol && keyboard_idle) {  #else  /* NKRO_ENABLE */                              if (keyboard_idle) {  #endif /* NKRO_ENABLE */ @@ -796,12 +823,8 @@ __attribute__((weak)) void restart_usb_driver(USBDriver *usbp) {  /* Idle requests timer code   * callback (called from ISR, unlocked state) */ -#if CH_KERNEL_MAJOR >= 7  static void keyboard_idle_timer_cb(struct ch_virtual_timer *timer, void *arg) {      (void)timer; -#elif CH_KERNEL_MAJOR <= 6 -static void keyboard_idle_timer_cb(void *arg) { -#endif      USBDriver *usbp = (USBDriver *)arg;      osalSysLockFromISR(); @@ -836,99 +859,61 @@ uint8_t keyboard_leds(void) {      return keyboard_led_state;  } -/* prepare and start sending a report IN - * not callable from ISR or locked state */ -void send_keyboard(report_keyboard_t *report) { -    osalSysLock(); -    if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) { -        goto unlock; -    } - -#ifdef NKRO_ENABLE -    if (keymap_config.nkro && keyboard_protocol) { /* NKRO protocol */ -        /* need to wait until the previous packet has made it through */ -        /* can rewrite this using the synchronous API, then would wait -         * until *after* the packet has been transmitted. I think -         * this is more efficient */ -        /* busy wait, should be short and not very common */ -        if (usbGetTransmitStatusI(&USB_DRIVER, SHARED_IN_EPNUM)) { -            /* Need to either suspend, or loop and call unlock/lock during -             * every iteration - otherwise the system will remain locked, -             * no interrupts served, so USB not going through as well. -             * Note: for suspend, need USB_USE_WAIT == TRUE in halconf.h */ -            osalThreadSuspendS(&(&USB_DRIVER)->epc[SHARED_IN_EPNUM]->in_state->thread); - -            /* after osalThreadSuspendS returns USB status might have changed */ -            if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) { -                goto unlock; -            } -        } -        usbStartTransmitI(&USB_DRIVER, SHARED_IN_EPNUM, (uint8_t *)report, sizeof(struct nkro_report)); -    } else -#endif /* NKRO_ENABLE */ -    {  /* regular protocol */ -        /* need to wait until the previous packet has made it through */ -        /* busy wait, should be short and not very common */ -        if (usbGetTransmitStatusI(&USB_DRIVER, KEYBOARD_IN_EPNUM)) { -            /* Need to either suspend, or loop and call unlock/lock during -             * every iteration - otherwise the system will remain locked, -             * no interrupts served, so USB not going through as well. -             * Note: for suspend, need USB_USE_WAIT == TRUE in halconf.h */ -            osalThreadSuspendS(&(&USB_DRIVER)->epc[KEYBOARD_IN_EPNUM]->in_state->thread); - -            /* after osalThreadSuspendS returns USB status might have changed */ -            if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) { -                goto unlock; -            } -        } -        uint8_t *data, size; -        if (keyboard_protocol) { -            data = (uint8_t *)report; -            size = KEYBOARD_REPORT_SIZE; -        } else { /* boot protocol */ -            data = &report->mods; -            size = 8; -        } -        usbStartTransmitI(&USB_DRIVER, KEYBOARD_IN_EPNUM, data, size); -    } -    keyboard_report_sent = *report; - -unlock: -    osalSysUnlock(); -} - -/* --------------------------------------------------------- - *                     Mouse functions - * --------------------------------------------------------- - */ - -#ifdef MOUSE_ENABLE -void send_mouse(report_mouse_t *report) { +void send_report(uint8_t endpoint, void *report, size_t size) {      osalSysLock();      if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) {          osalSysUnlock();          return;      } -    if (usbGetTransmitStatusI(&USB_DRIVER, MOUSE_IN_EPNUM)) { +    if (usbGetTransmitStatusI(&USB_DRIVER, endpoint)) {          /* Need to either suspend, or loop and call unlock/lock during           * every iteration - otherwise the system will remain locked,           * no interrupts served, so USB not going through as well.           * Note: for suspend, need USB_USE_WAIT == TRUE in halconf.h */ -        if (osalThreadSuspendTimeoutS(&(&USB_DRIVER)->epc[MOUSE_IN_EPNUM]->in_state->thread, TIME_MS2I(10)) == MSG_TIMEOUT) { +        if (osalThreadSuspendTimeoutS(&(&USB_DRIVER)->epc[endpoint]->in_state->thread, TIME_MS2I(10)) == MSG_TIMEOUT) {              osalSysUnlock();              return;          }      } -    usbStartTransmitI(&USB_DRIVER, MOUSE_IN_EPNUM, (uint8_t *)report, sizeof(report_mouse_t)); +    usbStartTransmitI(&USB_DRIVER, endpoint, report, size);      osalSysUnlock();  } -#else  /* MOUSE_ENABLE */ +/* prepare and start sending a report IN + * not callable from ISR or locked state */ +void send_keyboard(report_keyboard_t *report) { +    uint8_t ep   = KEYBOARD_IN_EPNUM; +    size_t  size = KEYBOARD_REPORT_SIZE; + +    /* If we're in Boot Protocol, don't send any report ID or other funky fields */ +    if (!keyboard_protocol) { +        send_report(ep, &report->mods, 8); +    } else { +#ifdef NKRO_ENABLE +        if (keymap_config.nkro) { +            ep   = SHARED_IN_EPNUM; +            size = sizeof(struct nkro_report); +        } +#endif + +        send_report(ep, report, size); +    } + +    keyboard_report_sent = *report; +} + +/* --------------------------------------------------------- + *                     Mouse functions + * --------------------------------------------------------- + */ +  void send_mouse(report_mouse_t *report) { -    (void)report; +#ifdef MOUSE_ENABLE +    send_report(MOUSE_IN_EPNUM, report, sizeof(report_mouse_t)); +    mouse_report_sent = *report; +#endif  } -#endif /* MOUSE_ENABLE */  /* ---------------------------------------------------------   *                   Extrakey functions @@ -937,97 +922,25 @@ void send_mouse(report_mouse_t *report) {  void send_extra(report_extra_t *report) {  #ifdef EXTRAKEY_ENABLE -    osalSysLock(); -    if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) { -        osalSysUnlock(); -        return; -    } - -    if (usbGetTransmitStatusI(&USB_DRIVER, SHARED_IN_EPNUM)) { -        /* Need to either suspend, or loop and call unlock/lock during -         * every iteration - otherwise the system will remain locked, -         * no interrupts served, so USB not going through as well. -         * Note: for suspend, need USB_USE_WAIT == TRUE in halconf.h */ -        if (osalThreadSuspendTimeoutS(&(&USB_DRIVER)->epc[SHARED_IN_EPNUM]->in_state->thread, TIME_MS2I(10)) == MSG_TIMEOUT) { -            osalSysUnlock(); -            return; -        } -    } - -    usbStartTransmitI(&USB_DRIVER, SHARED_IN_EPNUM, (uint8_t *)report, sizeof(report_extra_t)); -    osalSysUnlock(); +    send_report(SHARED_IN_EPNUM, report, sizeof(report_extra_t));  #endif  }  void send_programmable_button(report_programmable_button_t *report) {  #ifdef PROGRAMMABLE_BUTTON_ENABLE -    osalSysLock(); -    if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) { -        osalSysUnlock(); -        return; -    } - -    if (usbGetTransmitStatusI(&USB_DRIVER, SHARED_IN_EPNUM)) { -        /* Need to either suspend, or loop and call unlock/lock during -         * every iteration - otherwise the system will remain locked, -         * no interrupts served, so USB not going through as well. -         * Note: for suspend, need USB_USE_WAIT == TRUE in halconf.h */ -        if (osalThreadSuspendTimeoutS(&(&USB_DRIVER)->epc[SHARED_IN_EPNUM]->in_state->thread, TIME_MS2I(10)) == MSG_TIMEOUT) { -            osalSysUnlock(); -            return; -        } -    } - -    usbStartTransmitI(&USB_DRIVER, SHARED_IN_EPNUM, (uint8_t *)report, sizeof(report_programmable_button_t)); -    osalSysUnlock(); +    send_report(SHARED_IN_EPNUM, report, sizeof(report_programmable_button_t));  #endif  }  void send_joystick(report_joystick_t *report) {  #ifdef JOYSTICK_ENABLE -    osalSysLock(); -    if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) { -        osalSysUnlock(); -        return; -    } - -    if (usbGetTransmitStatusI(&USB_DRIVER, JOYSTICK_IN_EPNUM)) { -        /* Need to either suspend, or loop and call unlock/lock during -         * every iteration - otherwise the system will remain locked, -         * no interrupts served, so USB not going through as well. -         * Note: for suspend, need USB_USE_WAIT == TRUE in halconf.h */ -        if (osalThreadSuspendTimeoutS(&(&USB_DRIVER)->epc[JOYSTICK_IN_EPNUM]->in_state->thread, TIME_MS2I(10)) == MSG_TIMEOUT) { -            osalSysUnlock(); -            return; -        } -    } - -    usbStartTransmitI(&USB_DRIVER, JOYSTICK_IN_EPNUM, (uint8_t *)report, sizeof(report_joystick_t)); -    osalSysUnlock(); +    send_report(JOYSTICK_IN_EPNUM, report, sizeof(report_joystick_t));  #endif  }  void send_digitizer(report_digitizer_t *report) {  #ifdef DIGITIZER_ENABLE -    osalSysLock(); -    if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) { -        osalSysUnlock(); -        return; -    } - -    if (usbGetTransmitStatusI(&USB_DRIVER, DIGITIZER_IN_EPNUM)) { -        /* Need to either suspend, or loop and call unlock/lock during -         * every iteration - otherwise the system will remain locked, -         * no interrupts served, so USB not going through as well. -         * Note: for suspend, need USB_USE_WAIT == TRUE in halconf.h */ -        if (osalThreadSuspendTimeoutS(&(&USB_DRIVER)->epc[DIGITIZER_IN_EPNUM]->in_state->thread, TIME_MS2I(10)) == MSG_TIMEOUT) { -            osalSysUnlock(); -            return; -        } -    } - -    usbStartTransmitI(&USB_DRIVER, DIGITIZER_IN_EPNUM, (uint8_t *)report, sizeof(report_digitizer_t)); -    osalSysUnlock(); +    send_report(DIGITIZER_IN_EPNUM, report, sizeof(report_digitizer_t));  #endif  } diff --git a/tmk_core/protocol/lufa.mk b/tmk_core/protocol/lufa.mk index 00fec478ac..b048c1836c 100644 --- a/tmk_core/protocol/lufa.mk +++ b/tmk_core/protocol/lufa.mk @@ -18,7 +18,7 @@ LUFA_SRC = lufa.c \  	$(LUFA_SRC_USB)  ifeq ($(strip $(MIDI_ENABLE)), yes) -	include $(TMK_PATH)/protocol/midi.mk +	LUFA_SRC += $(LUFA_ROOT_PATH)/Drivers/USB/Class/Device/MIDIClassDevice.c  endif  ifeq ($(strip $(VIRTSER_ENABLE)), yes) diff --git a/tmk_core/protocol/lufa/lufa.c b/tmk_core/protocol/lufa/lufa.c index 8f36e02b9a..20bfc8fb3c 100644 --- a/tmk_core/protocol/lufa/lufa.c +++ b/tmk_core/protocol/lufa/lufa.c @@ -298,7 +298,7 @@ void EVENT_USB_Device_Reset(void) {   *   * FIXME: Needs doc   */ -void EVENT_USB_Device_Suspend() { +void EVENT_USB_Device_Suspend(void) {      print("[S]");      usb_device_state_set_suspend(USB_Device_ConfigurationNumber != 0, USB_Device_ConfigurationNumber); @@ -311,7 +311,7 @@ void EVENT_USB_Device_Suspend() {   *   * FIXME: Needs doc   */ -void EVENT_USB_Device_WakeUp() { +void EVENT_USB_Device_WakeUp(void) {      print("[W]");  #if defined(NO_USB_STARTUP_CHECK)      suspend_wakeup_init(); @@ -901,5 +901,5 @@ void protocol_post_task(void) {  }  uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint16_t wIndex, const void **const DescriptorAddress) { -    return get_usb_descriptor(wValue, wIndex, DescriptorAddress); +    return get_usb_descriptor(wValue, wIndex, USB_ControlRequest.wLength, DescriptorAddress);  } diff --git a/tmk_core/protocol/midi.mk b/tmk_core/protocol/midi.mk deleted file mode 100644 index a5f76b2d31..0000000000 --- a/tmk_core/protocol/midi.mk +++ /dev/null @@ -1,11 +0,0 @@ -MIDI_DIR = protocol/midi - -SRC += midi.c \ -	   midi_device.c \ -	   bytequeue/bytequeue.c \ -	   bytequeue/interrupt_setting.c \ -	   sysex_tools.c \ -     qmk_midi.c \ -	   $(LUFA_SRC_USBCLASS) - -VPATH += $(TMK_PATH)/$(MIDI_DIR) diff --git a/tmk_core/protocol/midi/Config/LUFAConfig.h b/tmk_core/protocol/midi/Config/LUFAConfig.h deleted file mode 100644 index dead96de78..0000000000 --- a/tmk_core/protocol/midi/Config/LUFAConfig.h +++ /dev/null @@ -1,91 +0,0 @@ -/* -             LUFA Library -     Copyright (C) Dean Camera, 2012. - -  dean [at] fourwalledcubicle [dot] com -           www.lufa-lib.org -*/ - -/* -  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com) - -  Permission to use, copy, modify, distribute, and sell this -  software and its documentation for any purpose is hereby granted -  without fee, provided that the above copyright notice appear in -  all copies and that both that the copyright notice and this -  permission notice and warranty disclaimer appear in supporting -  documentation, and that the name of the author not be used in -  advertising or publicity pertaining to distribution of the -  software without specific, written prior permission. - -  The author disclaim all warranties with regard to this -  software, including all implied warranties of merchantability -  and fitness.  In no event shall the author be liable for any -  special, indirect or consequential damages or any damages -  whatsoever resulting from loss of use, data or profits, whether -  in an action of contract, negligence or other tortious action, -  arising out of or in connection with the use or performance of -  this software. -*/ - -/** \file - *  \brief LUFA Library Configuration Header File - * - *  This header file is used to configure LUFA's compile time options, - *  as an alternative to the compile time constants supplied through - *  a makefile. - * - *  For information on what each token does, refer to the LUFA - *  manual section "Summary of Compile Tokens". - */ - -#pragma once - -#if (ARCH == ARCH_AVR8) - -/* Non-USB Related Configuration Tokens: */ -//		#define DISABLE_TERMINAL_CODES - -/* USB Class Driver Related Tokens: */ -//		#define HID_HOST_BOOT_PROTOCOL_ONLY -//		#define HID_STATETABLE_STACK_DEPTH       {Insert Value Here} -//		#define HID_USAGE_STACK_DEPTH            {Insert Value Here} -//		#define HID_MAX_COLLECTIONS              {Insert Value Here} -//		#define HID_MAX_REPORTITEMS              {Insert Value Here} -//		#define HID_MAX_REPORT_IDS               {Insert Value Here} -//		#define NO_CLASS_DRIVER_AUTOFLUSH - -/* General USB Driver Related Tokens: */ -//		#define ORDERED_EP_CONFIG -#    define USE_STATIC_OPTIONS (USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL) -#    define USB_DEVICE_ONLY -//		#define USB_HOST_ONLY -//		#define USB_STREAM_TIMEOUT_MS            {Insert Value Here} -//		#define NO_LIMITED_CONTROLLER_CONNECT -//		#define NO_SOF_EVENTS - -/* USB Device Mode Driver Related Tokens: */ -//		#define USE_RAM_DESCRIPTORS -#    define USE_FLASH_DESCRIPTORS -//		#define USE_EEPROM_DESCRIPTORS -//		#define NO_INTERNAL_SERIAL -#    define FIXED_CONTROL_ENDPOINT_SIZE 8 -//		#define DEVICE_STATE_AS_GPIOR            {Insert Value Here} -#    define FIXED_NUM_CONFIGURATIONS 1 -//		#define CONTROL_ONLY_DEVICE -//		#define INTERRUPT_CONTROL_ENDPOINT -//		#define NO_DEVICE_REMOTE_WAKEUP -//		#define NO_DEVICE_SELF_POWER - -/* USB Host Mode Driver Related Tokens: */ -//		#define HOST_STATE_AS_GPIOR              {Insert Value Here} -//		#define USB_HOST_TIMEOUT_MS              {Insert Value Here} -//		#define HOST_DEVICE_SETTLE_DELAY_MS	     {Insert Value Here} -//      #define NO_AUTO_VBUS_MANAGEMENT -//      #define INVERTED_VBUS_ENABLE_LINE - -#else - -#    error Unsupported architecture for this LUFA configuration file. - -#endif diff --git a/tmk_core/protocol/midi/bytequeue/COPYING b/tmk_core/protocol/midi/bytequeue/COPYING deleted file mode 100755 index 94a9ed024d..0000000000 --- a/tmk_core/protocol/midi/bytequeue/COPYING +++ /dev/null @@ -1,674 +0,0 @@ -                    GNU GENERAL PUBLIC LICENSE -                       Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -                            Preamble - -  The GNU General Public License is a free, copyleft license for -software and other kinds of works. - -  The licenses for most software and other practical works are designed -to take away your freedom to share and change the works.  By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users.  We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors.  You can apply it to -your programs, too. - -  When we speak of free software, we are referring to freedom, not -price.  Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - -  To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights.  Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - -  For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received.  You must make sure that they, too, receive -or can get the source code.  And you must show them these terms so they -know their rights. - -  Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - -  For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software.  For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - -  Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so.  This is fundamentally incompatible with the aim of -protecting users' freedom to change the software.  The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable.  Therefore, we -have designed this version of the GPL to prohibit the practice for those -products.  If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - -  Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary.  To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - -  The precise terms and conditions for copying, distribution and -modification follow. - -                       TERMS AND CONDITIONS - -  0. Definitions. - -  "This License" refers to version 3 of the GNU General Public License. - -  "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - -  "The Program" refers to any copyrightable work licensed under this -License.  Each licensee is addressed as "you".  "Licensees" and -"recipients" may be individuals or organizations. - -  To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy.  The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - -  A "covered work" means either the unmodified Program or a work based -on the Program. - -  To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy.  Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - -  To "convey" a work means any kind of propagation that enables other -parties to make or receive copies.  Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - -  An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License.  If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - -  1. Source Code. - -  The "source code" for a work means the preferred form of the work -for making modifications to it.  "Object code" means any non-source -form of a work. - -  A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - -  The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form.  A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - -  The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities.  However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work.  For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - -  The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - -  The Corresponding Source for a work in source code form is that -same work. - -  2. Basic Permissions. - -  All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met.  This License explicitly affirms your unlimited -permission to run the unmodified Program.  The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work.  This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - -  You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force.  You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright.  Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - -  Conveying under any other circumstances is permitted solely under -the conditions stated below.  Sublicensing is not allowed; section 10 -makes it unnecessary. - -  3. Protecting Users' Legal Rights From Anti-Circumvention Law. - -  No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - -  When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - -  4. Conveying Verbatim Copies. - -  You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - -  You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - -  5. Conveying Modified Source Versions. - -  You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - -    a) The work must carry prominent notices stating that you modified -    it, and giving a relevant date. - -    b) The work must carry prominent notices stating that it is -    released under this License and any conditions added under section -    7.  This requirement modifies the requirement in section 4 to -    "keep intact all notices". - -    c) You must license the entire work, as a whole, under this -    License to anyone who comes into possession of a copy.  This -    License will therefore apply, along with any applicable section 7 -    additional terms, to the whole of the work, and all its parts, -    regardless of how they are packaged.  This License gives no -    permission to license the work in any other way, but it does not -    invalidate such permission if you have separately received it. - -    d) If the work has interactive user interfaces, each must display -    Appropriate Legal Notices; however, if the Program has interactive -    interfaces that do not display Appropriate Legal Notices, your -    work need not make them do so. - -  A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit.  Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - -  6. Conveying Non-Source Forms. - -  You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - -    a) Convey the object code in, or embodied in, a physical product -    (including a physical distribution medium), accompanied by the -    Corresponding Source fixed on a durable physical medium -    customarily used for software interchange. - -    b) Convey the object code in, or embodied in, a physical product -    (including a physical distribution medium), accompanied by a -    written offer, valid for at least three years and valid for as -    long as you offer spare parts or customer support for that product -    model, to give anyone who possesses the object code either (1) a -    copy of the Corresponding Source for all the software in the -    product that is covered by this License, on a durable physical -    medium customarily used for software interchange, for a price no -    more than your reasonable cost of physically performing this -    conveying of source, or (2) access to copy the -    Corresponding Source from a network server at no charge. - -    c) Convey individual copies of the object code with a copy of the -    written offer to provide the Corresponding Source.  This -    alternative is allowed only occasionally and noncommercially, and -    only if you received the object code with such an offer, in accord -    with subsection 6b. - -    d) Convey the object code by offering access from a designated -    place (gratis or for a charge), and offer equivalent access to the -    Corresponding Source in the same way through the same place at no -    further charge.  You need not require recipients to copy the -    Corresponding Source along with the object code.  If the place to -    copy the object code is a network server, the Corresponding Source -    may be on a different server (operated by you or a third party) -    that supports equivalent copying facilities, provided you maintain -    clear directions next to the object code saying where to find the -    Corresponding Source.  Regardless of what server hosts the -    Corresponding Source, you remain obligated to ensure that it is -    available for as long as needed to satisfy these requirements. - -    e) Convey the object code using peer-to-peer transmission, provided -    you inform other peers where the object code and Corresponding -    Source of the work are being offered to the general public at no -    charge under subsection 6d. - -  A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - -  A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling.  In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage.  For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product.  A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - -  "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source.  The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - -  If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information.  But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - -  The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed.  Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - -  Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - -  7. Additional Terms. - -  "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law.  If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - -  When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it.  (Additional permissions may be written to require their own -removal in certain cases when you modify the work.)  You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - -  Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - -    a) Disclaiming warranty or limiting liability differently from the -    terms of sections 15 and 16 of this License; or - -    b) Requiring preservation of specified reasonable legal notices or -    author attributions in that material or in the Appropriate Legal -    Notices displayed by works containing it; or - -    c) Prohibiting misrepresentation of the origin of that material, or -    requiring that modified versions of such material be marked in -    reasonable ways as different from the original version; or - -    d) Limiting the use for publicity purposes of names of licensors or -    authors of the material; or - -    e) Declining to grant rights under trademark law for use of some -    trade names, trademarks, or service marks; or - -    f) Requiring indemnification of licensors and authors of that -    material by anyone who conveys the material (or modified versions of -    it) with contractual assumptions of liability to the recipient, for -    any liability that these contractual assumptions directly impose on -    those licensors and authors. - -  All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10.  If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term.  If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - -  If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - -  Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - -  8. Termination. - -  You may not propagate or modify a covered work except as expressly -provided under this License.  Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - -  However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - -  Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -  Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License.  If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - -  9. Acceptance Not Required for Having Copies. - -  You are not required to accept this License in order to receive or -run a copy of the Program.  Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance.  However, -nothing other than this License grants you permission to propagate or -modify any covered work.  These actions infringe copyright if you do -not accept this License.  Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - -  10. Automatic Licensing of Downstream Recipients. - -  Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License.  You are not responsible -for enforcing compliance by third parties with this License. - -  An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations.  If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - -  You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License.  For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - -  11. Patents. - -  A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based.  The -work thus licensed is called the contributor's "contributor version". - -  A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version.  For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - -  Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - -  In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement).  To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - -  If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients.  "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - -  If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - -  A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License.  You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - -  Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - -  12. No Surrender of Others' Freedom. - -  If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License.  If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all.  For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - -  13. Use with the GNU Affero General Public License. - -  Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work.  The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - -  14. Revised Versions of this License. - -  The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time.  Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -  Each version is given a distinguishing version number.  If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation.  If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - -  If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - -  Later license versions may give you additional or different -permissions.  However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - -  15. Disclaimer of Warranty. - -  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - -  16. Limitation of Liability. - -  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - -  17. Interpretation of Sections 15 and 16. - -  If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - -                     END OF TERMS AND CONDITIONS - -            How to Apply These Terms to Your New Programs - -  If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - -  To do so, attach the following notices to the program.  It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - -    <one line to give the program's name and a brief idea of what it does.> -    Copyright (C) <year>  <name of author> - -    This program is free software: you can redistribute it and/or modify -    it under the terms of the GNU General Public License as published by -    the Free Software Foundation, either version 3 of the License, or -    (at your option) any later version. - -    This program is distributed in the hope that it will be useful, -    but WITHOUT ANY WARRANTY; without even the implied warranty of -    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -    GNU General Public License for more details. - -    You should have received a copy of the GNU General Public License -    along with this program.  If not, see <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - -  If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - -    <program>  Copyright (C) <year>  <name of author> -    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. -    This is free software, and you are welcome to redistribute it -    under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License.  Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - -  You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - -  The GNU General Public License does not permit incorporating your program -into proprietary programs.  If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library.  If this is what you want to do, use the GNU Lesser General -Public License instead of this License.  But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/tmk_core/protocol/midi/bytequeue/bytequeue.c b/tmk_core/protocol/midi/bytequeue/bytequeue.c deleted file mode 100644 index 0dd18680f0..0000000000 --- a/tmk_core/protocol/midi/bytequeue/bytequeue.c +++ /dev/null @@ -1,64 +0,0 @@ -// this is a single reader [maybe multiple writer?] byte queue -// Copyright 2008 Alex Norman -// writen by Alex Norman -// -// This file is part of avr-bytequeue. -// -// avr-bytequeue is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-bytequeue is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-bytequeue.  If not, see <http://www.gnu.org/licenses/>. - -#include "bytequeue.h" -#include "interrupt_setting.h" - -void bytequeue_init(byteQueue_t* queue, uint8_t* dataArray, byteQueueIndex_t arrayLen) { -    queue->length = arrayLen; -    queue->data   = dataArray; -    queue->start = queue->end = 0; -} - -bool bytequeue_enqueue(byteQueue_t* queue, uint8_t item) { -    interrupt_setting_t setting = store_and_clear_interrupt(); -    // full -    if (((queue->end + 1) % queue->length) == queue->start) { -        restore_interrupt_setting(setting); -        return false; -    } else { -        queue->data[queue->end] = item; -        queue->end              = (queue->end + 1) % queue->length; -        restore_interrupt_setting(setting); -        return true; -    } -} - -byteQueueIndex_t bytequeue_length(byteQueue_t* queue) { -    byteQueueIndex_t    len; -    interrupt_setting_t setting = store_and_clear_interrupt(); -    if (queue->end >= queue->start) -        len = queue->end - queue->start; -    else -        len = (queue->length - queue->start) + queue->end; -    restore_interrupt_setting(setting); -    return len; -} - -// we don't need to avoid interrupts if there is only one reader -uint8_t bytequeue_get(byteQueue_t* queue, byteQueueIndex_t index) { -    return queue->data[(queue->start + index) % queue->length]; -} - -// we just update the start index to remove elements -void bytequeue_remove(byteQueue_t* queue, byteQueueIndex_t numToRemove) { -    interrupt_setting_t setting = store_and_clear_interrupt(); -    queue->start                = (queue->start + numToRemove) % queue->length; -    restore_interrupt_setting(setting); -} diff --git a/tmk_core/protocol/midi/bytequeue/bytequeue.h b/tmk_core/protocol/midi/bytequeue/bytequeue.h deleted file mode 100644 index 29d15abbd3..0000000000 --- a/tmk_core/protocol/midi/bytequeue/bytequeue.h +++ /dev/null @@ -1,55 +0,0 @@ -// this is a single reader [maybe multiple writer?] byte queue -// Copyright 2008 Alex Norman -// writen by Alex Norman -// -// This file is part of avr-bytequeue. -// -// avr-bytequeue is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-bytequeue is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-bytequeue.  If not, see <http://www.gnu.org/licenses/>. - -#pragma once - -#ifdef __cplusplus -extern "C" { -#endif - -#include <inttypes.h> -#include <stdbool.h> - -typedef uint8_t byteQueueIndex_t; - -typedef struct { -    byteQueueIndex_t start; -    byteQueueIndex_t end; -    byteQueueIndex_t length; -    uint8_t*         data; -} byteQueue_t; - -// you must have a queue, an array of data which the queue will use, and the length of that array -void bytequeue_init(byteQueue_t* queue, uint8_t* dataArray, byteQueueIndex_t arrayLen); - -// add an item to the queue, returns false if the queue is full -bool bytequeue_enqueue(byteQueue_t* queue, uint8_t item); - -// get the length of the queue -byteQueueIndex_t bytequeue_length(byteQueue_t* queue); - -// this grabs data at the index given [starting at queue->start] -uint8_t bytequeue_get(byteQueue_t* queue, byteQueueIndex_t index); - -// update the index in the queue to reflect data that has been dealt with -void bytequeue_remove(byteQueue_t* queue, byteQueueIndex_t numToRemove); - -#ifdef __cplusplus -} -#endif diff --git a/tmk_core/protocol/midi/bytequeue/interrupt_setting.c b/tmk_core/protocol/midi/bytequeue/interrupt_setting.c deleted file mode 100644 index d9c0035946..0000000000 --- a/tmk_core/protocol/midi/bytequeue/interrupt_setting.c +++ /dev/null @@ -1,47 +0,0 @@ -// Copyright 20010 Alex Norman -// writen by Alex Norman -// -// This file is part of avr-bytequeue. -// -// avr-bytequeue is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-bytequeue is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-bytequeue.  If not, see <http://www.gnu.org/licenses/>. - -// AVR specific code -// should be able to port to other systems by simply providing chip specific -// implementations of the typedef and these functions - -#include "interrupt_setting.h" -#if defined(__AVR__) -#    include <avr/interrupt.h> - -interrupt_setting_t store_and_clear_interrupt(void) { -    uint8_t sreg = SREG; -    cli(); -    return sreg; -} - -void restore_interrupt_setting(interrupt_setting_t setting) { -    SREG = setting; -} -#elif defined(__arm__) -#    include <ch.h> - -interrupt_setting_t store_and_clear_interrupt(void) { -    chSysLock(); -    return 0; -} - -void restore_interrupt_setting(interrupt_setting_t setting) { -    chSysUnlock(); -} -#endif diff --git a/tmk_core/protocol/midi/bytequeue/interrupt_setting.h b/tmk_core/protocol/midi/bytequeue/interrupt_setting.h deleted file mode 100644 index 78294f0765..0000000000 --- a/tmk_core/protocol/midi/bytequeue/interrupt_setting.h +++ /dev/null @@ -1,35 +0,0 @@ -// Copyright 20010 Alex Norman -// writen by Alex Norman -// -// This file is part of avr-bytequeue. -// -// avr-bytequeue is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-bytequeue is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-bytequeue.  If not, see <http://www.gnu.org/licenses/>. - -#pragma once - -#ifdef __cplusplus -extern "C" { -#endif - -#include <inttypes.h> - -// AVR specific typedef -typedef uint8_t interrupt_setting_t; - -interrupt_setting_t store_and_clear_interrupt(void); -void                restore_interrupt_setting(interrupt_setting_t setting); - -#ifdef __cplusplus -} -#endif diff --git a/tmk_core/protocol/midi/midi.c b/tmk_core/protocol/midi/midi.c deleted file mode 100644 index 1ba3e73a40..0000000000 --- a/tmk_core/protocol/midi/midi.c +++ /dev/null @@ -1,247 +0,0 @@ -// midi for embedded chips, -// Copyright 2010 Alex Norman -// -// This file is part of avr-midi. -// -// avr-midi is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-midi is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-midi.  If not, see <http://www.gnu.org/licenses/>. - -#include "midi.h" -#include <string.h> //for memcpy - -#ifndef MIN -#    define MIN(x, y) (((x) < (y)) ? (x) : (y)) -#endif - -#ifndef NULL -#    define NULL 0 -#endif - -bool midi_is_statusbyte(uint8_t theByte) { -    return (bool)(theByte & MIDI_STATUSMASK); -} - -bool midi_is_realtime(uint8_t theByte) { -    return (theByte >= MIDI_CLOCK); -} - -midi_packet_length_t midi_packet_length(uint8_t status) { -    switch (status & 0xF0) { -        case MIDI_CC: -        case MIDI_NOTEON: -        case MIDI_NOTEOFF: -        case MIDI_AFTERTOUCH: -        case MIDI_PITCHBEND: -            return THREE; -        case MIDI_PROGCHANGE: -        case MIDI_CHANPRESSURE: -        case MIDI_SONGSELECT: -            return TWO; -        case 0xF0: -            switch (status) { -                case MIDI_CLOCK: -                case MIDI_TICK: -                case MIDI_START: -                case MIDI_CONTINUE: -                case MIDI_STOP: -                case MIDI_ACTIVESENSE: -                case MIDI_RESET: -                case MIDI_TUNEREQUEST: -                    return ONE; -                case MIDI_SONGPOSITION: -                    return THREE; -                case MIDI_TC_QUARTERFRAME: -                case MIDI_SONGSELECT: -                    return TWO; -                case SYSEX_END: -                case SYSEX_BEGIN: -                default: -                    return UNDEFINED; -            } -        default: -            return UNDEFINED; -    } -} - -void midi_send_cc(MidiDevice* device, uint8_t chan, uint8_t num, uint8_t val) { -    // CC Status: 0xB0 to 0xBF where the low nibble is the MIDI channel. -    // CC Data: Controller Num, Controller Val -    device->send_func(device, 3, MIDI_CC | (chan & MIDI_CHANMASK), num & 0x7F, val & 0x7F); -} - -void midi_send_noteon(MidiDevice* device, uint8_t chan, uint8_t num, uint8_t vel) { -    // Note Data: Note Num, Note Velocity -    device->send_func(device, 3, MIDI_NOTEON | (chan & MIDI_CHANMASK), num & 0x7F, vel & 0x7F); -} - -void midi_send_noteoff(MidiDevice* device, uint8_t chan, uint8_t num, uint8_t vel) { -    // Note Data: Note Num, Note Velocity -    device->send_func(device, 3, MIDI_NOTEOFF | (chan & MIDI_CHANMASK), num & 0x7F, vel & 0x7F); -} - -void midi_send_aftertouch(MidiDevice* device, uint8_t chan, uint8_t note_num, uint8_t amt) { -    device->send_func(device, 3, MIDI_AFTERTOUCH | (chan & MIDI_CHANMASK), note_num & 0x7F, amt & 0x7F); -} - -// XXX does this work right? -// amt in range -0x2000, 0x1fff -// uAmt should be in range.. -// 0x0000 to 0x3FFF -void midi_send_pitchbend(MidiDevice* device, uint8_t chan, int16_t amt) { -    uint16_t uAmt; -    // check range -    if (amt > 0x1fff) { -        uAmt = 0x3FFF; -    } else if (amt < -0x2000) { -        uAmt = 0; -    } else { -        uAmt = amt + 0x2000; -    } -    device->send_func(device, 3, MIDI_PITCHBEND | (chan & MIDI_CHANMASK), uAmt & 0x7F, (uAmt >> 7) & 0x7F); -} - -void midi_send_programchange(MidiDevice* device, uint8_t chan, uint8_t num) { -    device->send_func(device, 2, MIDI_PROGCHANGE | (chan & MIDI_CHANMASK), num & 0x7F, 0); -} - -void midi_send_channelpressure(MidiDevice* device, uint8_t chan, uint8_t amt) { -    device->send_func(device, 2, MIDI_CHANPRESSURE | (chan & MIDI_CHANMASK), amt & 0x7F, 0); -} - -void midi_send_clock(MidiDevice* device) { -    device->send_func(device, 1, MIDI_CLOCK, 0, 0); -} - -void midi_send_tick(MidiDevice* device) { -    device->send_func(device, 1, MIDI_TICK, 0, 0); -} - -void midi_send_start(MidiDevice* device) { -    device->send_func(device, 1, MIDI_START, 0, 0); -} - -void midi_send_continue(MidiDevice* device) { -    device->send_func(device, 1, MIDI_CONTINUE, 0, 0); -} - -void midi_send_stop(MidiDevice* device) { -    device->send_func(device, 1, MIDI_STOP, 0, 0); -} - -void midi_send_activesense(MidiDevice* device) { -    device->send_func(device, 1, MIDI_ACTIVESENSE, 0, 0); -} - -void midi_send_reset(MidiDevice* device) { -    device->send_func(device, 1, MIDI_RESET, 0, 0); -} - -void midi_send_tcquarterframe(MidiDevice* device, uint8_t time) { -    device->send_func(device, 2, MIDI_TC_QUARTERFRAME, time & 0x7F, 0); -} - -// XXX is this right? -void midi_send_songposition(MidiDevice* device, uint16_t pos) { -    device->send_func(device, 3, MIDI_SONGPOSITION, pos & 0x7F, (pos >> 7) & 0x7F); -} - -void midi_send_songselect(MidiDevice* device, uint8_t song) { -    device->send_func(device, 2, MIDI_SONGSELECT, song & 0x7F, 0); -} - -void midi_send_tunerequest(MidiDevice* device) { -    device->send_func(device, 1, MIDI_TUNEREQUEST, 0, 0); -} - -void midi_send_byte(MidiDevice* device, uint8_t b) { -    device->send_func(device, 1, b, 0, 0); -} - -void midi_send_data(MidiDevice* device, uint16_t count, uint8_t byte0, uint8_t byte1, uint8_t byte2) { -    // ensure that the count passed along is always 3 or lower -    if (count > 3) { -        // TODO how to do this correctly? -    } -    device->send_func(device, count, byte0, byte1, byte2); -} - -void midi_send_array(MidiDevice* device, uint16_t count, uint8_t* array) { -    uint16_t i; -    for (i = 0; i < count; i += 3) { -        uint8_t  b[3]    = {0, 0, 0}; -        uint16_t to_send = count - i; -        to_send          = (to_send > 3) ? 3 : to_send; -        memcpy(b, array + i, to_send); -        midi_send_data(device, to_send, b[0], b[1], b[2]); -    } -} - -void midi_register_cc_callback(MidiDevice* device, midi_three_byte_func_t func) { -    device->input_cc_callback = func; -} - -void midi_register_noteon_callback(MidiDevice* device, midi_three_byte_func_t func) { -    device->input_noteon_callback = func; -} - -void midi_register_noteoff_callback(MidiDevice* device, midi_three_byte_func_t func) { -    device->input_noteoff_callback = func; -} - -void midi_register_aftertouch_callback(MidiDevice* device, midi_three_byte_func_t func) { -    device->input_aftertouch_callback = func; -} - -void midi_register_pitchbend_callback(MidiDevice* device, midi_three_byte_func_t func) { -    device->input_pitchbend_callback = func; -} - -void midi_register_songposition_callback(MidiDevice* device, midi_three_byte_func_t func) { -    device->input_songposition_callback = func; -} - -void midi_register_progchange_callback(MidiDevice* device, midi_two_byte_func_t func) { -    device->input_progchange_callback = func; -} - -void midi_register_chanpressure_callback(MidiDevice* device, midi_two_byte_func_t func) { -    device->input_chanpressure_callback = func; -} - -void midi_register_songselect_callback(MidiDevice* device, midi_two_byte_func_t func) { -    device->input_songselect_callback = func; -} - -void midi_register_tc_quarterframe_callback(MidiDevice* device, midi_two_byte_func_t func) { -    device->input_tc_quarterframe_callback = func; -} - -void midi_register_realtime_callback(MidiDevice* device, midi_one_byte_func_t func) { -    device->input_realtime_callback = func; -} - -void midi_register_tunerequest_callback(MidiDevice* device, midi_one_byte_func_t func) { -    device->input_tunerequest_callback = func; -} - -void midi_register_sysex_callback(MidiDevice* device, midi_sysex_func_t func) { -    device->input_sysex_callback = func; -} - -void midi_register_fallthrough_callback(MidiDevice* device, midi_var_byte_func_t func) { -    device->input_fallthrough_callback = func; -} - -void midi_register_catchall_callback(MidiDevice* device, midi_var_byte_func_t func) { -    device->input_catchall_callback = func; -} diff --git a/tmk_core/protocol/midi/midi.h b/tmk_core/protocol/midi/midi.h deleted file mode 100644 index 34547077e4..0000000000 --- a/tmk_core/protocol/midi/midi.h +++ /dev/null @@ -1,487 +0,0 @@ -// midi for embedded chips, -// Copyright 2010 Alex Norman -// -// This file is part of avr-midi. -// -// avr-midi is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-midi is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-midi.  If not, see <http://www.gnu.org/licenses/>. - -/** - * @file - * @brief The main midi functions - * - * This file includes all of the functions you need to set up and process a - * midi device, send midi, and register midi callbacks. - * - */ - -#pragma once - -#ifdef __cplusplus -extern "C" { -#endif - -#include "midi_device.h" -#include "midi_function_types.h" - -/** - * @defgroup midi_device_setup_process Device initialization and processing - * @brief These are method that you must use to initialize and run a device - * - * @{ - */ - -/** - * @brief Initialize a device - * - * You must call this before using the device in question. - * - * @param device the device to initialize - */ -void midi_device_init(MidiDevice* device); // [implementation in midi_device.c] - -/** - * @brief Process input data - * - * This method drives the input processing, you must call this method frequently - * if you expect to have your input callbacks called. - * - * @param device the device to process - */ -void midi_device_process(MidiDevice* device); // [implementation in midi_device.c] - -/**@}*/ - -/** - * @defgroup send_functions Midi send functions - * @brief These are the functions you use to send midi data through a device. - * @{ - */ - -/** - * @brief Send a control change message (cc) via the given device. - * - * @param device the device to use for sending - * @param chan the channel to send on, 0-15 - * @param num the cc num - * @param val the value of that cc num - */ -void midi_send_cc(MidiDevice* device, uint8_t chan, uint8_t num, uint8_t val); - -/** - * @brief Send a note on message via the given device. - * - * @param device the device to use for sending - * @param chan the channel to send on, 0-15 - * @param num the note number - * @param vel the note velocity - */ -void midi_send_noteon(MidiDevice* device, uint8_t chan, uint8_t num, uint8_t vel); - -/** - * @brief Send a note off message via the given device. - * - * @param device the device to use for sending - * @param chan the channel to send on, 0-15 - * @param num the note number - * @param vel the note velocity - */ -void midi_send_noteoff(MidiDevice* device, uint8_t chan, uint8_t num, uint8_t vel); - -/** - * @brief Send an after touch message via the given device. - * - * @param device the device to use for sending - * @param chan the channel to send on, 0-15 - * @param note_num the note number - * @param amt the after touch amount - */ -void midi_send_aftertouch(MidiDevice* device, uint8_t chan, uint8_t note_num, uint8_t amt); - -/** - * @brief Send a pitch bend message via the given device. - * - * @param device the device to use for sending - * @param chan the channel to send on, 0-15 - * @param amt the bend amount range: -8192..8191, 0 means no bend - */ -void midi_send_pitchbend(MidiDevice* device, uint8_t chan, int16_t amt); // range -8192, 8191 - -/** - * @brief Send a program change message via the given device. - * - * @param device the device to use for sending - * @param chan the channel to send on, 0-15 - * @param num the program to change to - */ -void midi_send_programchange(MidiDevice* device, uint8_t chan, uint8_t num); - -/** - * @brief Send a channel pressure message via the given device. - * - * @param device the device to use for sending - * @param chan the channel to send on, 0-15 - * @param amt the amount of channel pressure - */ -void midi_send_channelpressure(MidiDevice* device, uint8_t chan, uint8_t amt); - -/** - * @brief Send a clock message via the given device. - * - * @param device the device to use for sending - */ -void midi_send_clock(MidiDevice* device); - -/** - * @brief Send a tick message via the given device. - * - * @param device the device to use for sending - */ -void midi_send_tick(MidiDevice* device); - -/** - * @brief Send a start message via the given device. - * - * @param device the device to use for sending - */ -void midi_send_start(MidiDevice* device); - -/** - * @brief Send a continue message via the given device. - * - * @param device the device to use for sending - */ -void midi_send_continue(MidiDevice* device); - -/** - * @brief Send a stop message via the given device. - * - * @param device the device to use for sending - */ -void midi_send_stop(MidiDevice* device); - -/** - * @brief Send an active sense message via the given device. - * - * @param device the device to use for sending - */ -void midi_send_activesense(MidiDevice* device); - -/** - * @brief Send a reset message via the given device. - * - * @param device the device to use for sending - */ -void midi_send_reset(MidiDevice* device); - -/** - * @brief Send a tc quarter frame message via the given device. - * - * @param device the device to use for sending - * @param time the time of this quarter frame, range 0..16383 - */ -void midi_send_tcquarterframe(MidiDevice* device, uint8_t time); - -/** - * @brief Send a song position message via the given device. - * - * @param device the device to use for sending - * @param pos the song position - */ -void midi_send_songposition(MidiDevice* device, uint16_t pos); - -/** - * @brief Send a song select message via the given device. - * - * @param device the device to use for sending - * @param song the song to select - */ -void midi_send_songselect(MidiDevice* device, uint8_t song); - -/** - * @brief Send a tune request message via the given device. - * - * @param device the device to use for sending - */ -void midi_send_tunerequest(MidiDevice* device); - -/** - * @brief Send a byte via the given device. - * - * This is a generic method for sending data via the given midi device. - * This would be useful for sending sysex data or messages that are not - * implemented in this API, if there are any.  Please contact the author - * if you find some so we can add them. - * - * @param device the device to use for sending - * @param b the byte to send - */ -void midi_send_byte(MidiDevice* device, uint8_t b); - -/** - * @brief Send up to 3 bytes of data - * - * % 4 is applied to count so that you can use this to pass sysex through - * - * @param device the device to use for sending - * @param count the count of bytes to send, %4 is applied - * @param byte0 the first byte - * @param byte1 the second byte, ignored if cnt % 4 != 2 - * @param byte2 the third byte, ignored if cnt % 4 != 3 - */ -void midi_send_data(MidiDevice* device, uint16_t count, uint8_t byte0, uint8_t byte1, uint8_t byte2); - -/** - * @brief Send an array of formatted midi data. - * - * Can be used for sysex. - * - * @param device the device to use for sending - * @param count the count of bytes to send - * @param array the array of bytes - */ -void midi_send_array(MidiDevice* device, uint16_t count, uint8_t* array); - -/**@}*/ - -/** - * @defgroup input_callback_reg Input callback registration functions - * - * @brief These are the functions you use to register your input callbacks. - * - * The functions are called when the appropriate midi message is matched on the - * associated device's input. - * - * @{ - */ - -// three byte funcs - -/** - * @brief Register a control change message (cc) callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_cc_callback(MidiDevice* device, midi_three_byte_func_t func); - -/** - * @brief Register a note on callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_noteon_callback(MidiDevice* device, midi_three_byte_func_t func); - -/** - * @brief Register a note off callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_noteoff_callback(MidiDevice* device, midi_three_byte_func_t func); - -/** - * @brief Register an after touch callback. - * - * @param device the device associate with - * @param func the callback function to register - */ - -void midi_register_aftertouch_callback(MidiDevice* device, midi_three_byte_func_t func); - -/** - * @brief Register a pitch bend callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_pitchbend_callback(MidiDevice* device, midi_three_byte_func_t func); - -/** - * @brief Register a song position callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_songposition_callback(MidiDevice* device, midi_three_byte_func_t func); - -// two byte funcs - -/** - * @brief Register a program change callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_progchange_callback(MidiDevice* device, midi_two_byte_func_t func); - -/** - * @brief Register a channel pressure callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_chanpressure_callback(MidiDevice* device, midi_two_byte_func_t func); - -/** - * @brief Register a song select callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_songselect_callback(MidiDevice* device, midi_two_byte_func_t func); - -/** - * @brief Register a tc quarter frame callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_tc_quarterframe_callback(MidiDevice* device, midi_two_byte_func_t func); - -// one byte funcs - -/** - * @brief Register a realtime callback. - * - * The callback will be called for all of the real time message types. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_realtime_callback(MidiDevice* device, midi_one_byte_func_t func); - -/** - * @brief Register a tune request callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_tunerequest_callback(MidiDevice* device, midi_one_byte_func_t func); - -/** - * @brief Register a sysex callback. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_sysex_callback(MidiDevice* device, midi_sysex_func_t func); - -/** - * @brief Register fall through callback. - * - * This is only called if a more specific callback is not matched and called. - * For instance, if you don't register a note on callback but you get a note on message - * the fall through callback will be called, if it is registered. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_fallthrough_callback(MidiDevice* device, midi_var_byte_func_t func); - -/** - * @brief Register a catch all callback. - * - * If registered, the catch all callback is called for every message that is - * matched, even if a more specific or the fallthrough callback is registered. - * - * @param device the device associate with - * @param func the callback function to register - */ -void midi_register_catchall_callback(MidiDevice* device, midi_var_byte_func_t func); - -/**@}*/ - -/** - * @defgroup midi_util Device independent utility functions. - * @{ - */ - -/** - * \enum midi_packet_length_t - * - * An enumeration of the possible packet length values. - */ -typedef enum { UNDEFINED = 0, ONE = 1, TWO = 2, THREE = 3 } midi_packet_length_t; - -/** - * @brief Test to see if the byte given is a status byte - * @param theByte the byte to test - * @return true if the byte given is a midi status byte - */ -bool midi_is_statusbyte(uint8_t theByte); - -/** - * @brief Test to see if the byte given is a realtime message - * @param theByte the byte to test - * @return true if it is a realtime message, false otherwise - */ -bool midi_is_realtime(uint8_t theByte); - -/** - * @brief Find the length of the packet associated with the status byte given - * @param status the status byte - * @return the length of the packet, will return UNDEFINED if the byte is not - * a status byte or if it is a sysex status byte - */ -midi_packet_length_t midi_packet_length(uint8_t status); - -/**@}*/ - -/** - * @defgroup defines Midi status and miscellaneous utility #defines - * - * @{ - */ - -#define SYSEX_BEGIN 0xF0 -#define SYSEX_END 0xF7 - -// if you and this with a byte and you get anything non-zero -// it is a status message -#define MIDI_STATUSMASK 0x80 -// if you and this with a status message that contains channel info, -// you'll get the channel -#define MIDI_CHANMASK 0x0F - -#define MIDI_CC 0xB0 -#define MIDI_NOTEON 0x90 -#define MIDI_NOTEOFF 0x80 -#define MIDI_AFTERTOUCH 0xA0 -#define MIDI_PITCHBEND 0xE0 -#define MIDI_PROGCHANGE 0xC0 -#define MIDI_CHANPRESSURE 0xD0 - -// midi realtime -#define MIDI_CLOCK 0xF8 -#define MIDI_TICK 0xF9 -#define MIDI_START 0xFA -#define MIDI_CONTINUE 0xFB -#define MIDI_STOP 0xFC -#define MIDI_ACTIVESENSE 0xFE -#define MIDI_RESET 0xFF - -#define MIDI_TC_QUARTERFRAME 0xF1 -#define MIDI_SONGPOSITION 0xF2 -#define MIDI_SONGSELECT 0xF3 -#define MIDI_TUNEREQUEST 0xF6 - -// This ID is for educational or development use only -#define SYSEX_EDUMANUFID 0x7D - -/**@}*/ - -#ifdef __cplusplus -} -#endif diff --git a/tmk_core/protocol/midi/midi_device.c b/tmk_core/protocol/midi/midi_device.c deleted file mode 100644 index 77c010b156..0000000000 --- a/tmk_core/protocol/midi/midi_device.c +++ /dev/null @@ -1,277 +0,0 @@ -// midi for embedded chips, -// Copyright 2010 Alex Norman -// -// This file is part of avr-midi. -// -// avr-midi is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-midi is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-midi.  If not, see <http://www.gnu.org/licenses/>. - -#include "midi_device.h" -#include "midi.h" - -#ifndef NULL -#    define NULL 0 -#endif - -// forward declarations, internally used to call the callbacks -void midi_input_callbacks(MidiDevice* device, uint16_t cnt, uint8_t byte0, uint8_t byte1, uint8_t byte2); -void midi_process_byte(MidiDevice* device, uint8_t input); - -void midi_device_init(MidiDevice* device) { -    device->input_state = IDLE; -    device->input_count = 0; -    bytequeue_init(&device->input_queue, device->input_queue_data, MIDI_INPUT_QUEUE_LENGTH); - -    // three byte funcs -    device->input_cc_callback           = NULL; -    device->input_noteon_callback       = NULL; -    device->input_noteoff_callback      = NULL; -    device->input_aftertouch_callback   = NULL; -    device->input_pitchbend_callback    = NULL; -    device->input_songposition_callback = NULL; - -    // two byte funcs -    device->input_progchange_callback      = NULL; -    device->input_chanpressure_callback    = NULL; -    device->input_songselect_callback      = NULL; -    device->input_tc_quarterframe_callback = NULL; - -    // one byte funcs -    device->input_realtime_callback    = NULL; -    device->input_tunerequest_callback = NULL; - -    // var byte functions -    device->input_sysex_callback       = NULL; -    device->input_fallthrough_callback = NULL; -    device->input_catchall_callback    = NULL; - -    device->pre_input_process_callback = NULL; -} - -void midi_device_input(MidiDevice* device, uint8_t cnt, uint8_t* input) { -    uint8_t i; -    for (i = 0; i < cnt; i++) -        bytequeue_enqueue(&device->input_queue, input[i]); -} - -void midi_device_set_send_func(MidiDevice* device, midi_var_byte_func_t send_func) { -    device->send_func = send_func; -} - -void midi_device_set_pre_input_process_func(MidiDevice* device, midi_no_byte_func_t pre_process_func) { -    device->pre_input_process_callback = pre_process_func; -} - -void midi_device_process(MidiDevice* device) { -    // call the pre_input_process_callback if there is one -    if (device->pre_input_process_callback) device->pre_input_process_callback(device); - -    // pull stuff off the queue and process -    byteQueueIndex_t len = bytequeue_length(&device->input_queue); -    uint16_t         i; -    // TODO limit number of bytes processed? -    for (i = 0; i < len; i++) { -        uint8_t val = bytequeue_get(&device->input_queue, 0); -        midi_process_byte(device, val); -        bytequeue_remove(&device->input_queue, 1); -    } -} - -void midi_process_byte(MidiDevice* device, uint8_t input) { -    if (midi_is_realtime(input)) { -        // call callback, store and restore state -        input_state_t state = device->input_state; -        device->input_state = ONE_BYTE_MESSAGE; -        midi_input_callbacks(device, 1, input, 0, 0); -        device->input_state = state; -    } else if (midi_is_statusbyte(input)) { -        // store the byte -        if (device->input_state != SYSEX_MESSAGE) { -            device->input_buffer[0] = input; -            device->input_count     = 1; -        } -        switch (midi_packet_length(input)) { -            case ONE: -                device->input_state = ONE_BYTE_MESSAGE; -                ; -                midi_input_callbacks(device, 1, input, 0, 0); -                device->input_state = IDLE; -                break; -            case TWO: -                device->input_state = TWO_BYTE_MESSAGE; -                break; -            case THREE: -                device->input_state = THREE_BYTE_MESSAGE; -                break; -            case UNDEFINED: -                switch (input) { -                    case SYSEX_BEGIN: -                        device->input_state     = SYSEX_MESSAGE; -                        device->input_buffer[0] = input; -                        device->input_count     = 1; -                        break; -                    case SYSEX_END: -                        // send what is left in the input buffer, set idle -                        device->input_buffer[device->input_count % 3] = input; -                        device->input_count += 1; -                        // call the callback -                        midi_input_callbacks(device, device->input_count, device->input_buffer[0], device->input_buffer[1], device->input_buffer[2]); -                        device->input_state = IDLE; -                        break; -                    default: -                        device->input_state = IDLE; -                        device->input_count = 0; -                } - -                break; -            default: -                device->input_state = IDLE; -                device->input_count = 0; -                break; -        } -    } else { -        if (device->input_state != IDLE) { -            // store the byte -            device->input_buffer[device->input_count % 3] = input; -            // increment count -            uint16_t prev = device->input_count; -            device->input_count += 1; - -            switch (prev % 3) { -                case 2: -                    // call callback -                    midi_input_callbacks(device, device->input_count, device->input_buffer[0], device->input_buffer[1], device->input_buffer[2]); -                    if (device->input_state != SYSEX_MESSAGE) { -                        // set to 1, keeping status byte, allowing for running status -                        device->input_count = 1; -                    } -                    break; -                case 1: -                    if (device->input_state == TWO_BYTE_MESSAGE) { -                        // call callback -                        midi_input_callbacks(device, device->input_count, device->input_buffer[0], device->input_buffer[1], 0); -                        if (device->input_state != SYSEX_MESSAGE) { -                            // set to 1, keeping status byte, allowing for running status -                            device->input_count = 1; -                        } -                    } -                    break; -                case 0: -                default: -                    // one byte messages are dealt with directly -                    break; -            } -        } -    } -} - -void midi_input_callbacks(MidiDevice* device, uint16_t cnt, uint8_t byte0, uint8_t byte1, uint8_t byte2) { -    // did we end up calling a callback? -    bool called = false; -    if (device->input_state == SYSEX_MESSAGE) { -        if (device->input_sysex_callback) { -            const uint16_t start  = ((cnt - 1) / 3) * 3; -            const uint8_t  length = (cnt - start); -            uint8_t        data[3]; -            data[0] = byte0; -            data[1] = byte1; -            data[2] = byte2; -            device->input_sysex_callback(device, start, length, data); -            called = true; -        } -    } else { -        switch (cnt) { -            case 3: { -                midi_three_byte_func_t func = NULL; -                switch (byte0 & 0xF0) { -                    case MIDI_CC: -                        func = device->input_cc_callback; -                        break; -                    case MIDI_NOTEON: -                        func = device->input_noteon_callback; -                        break; -                    case MIDI_NOTEOFF: -                        func = device->input_noteoff_callback; -                        break; -                    case MIDI_AFTERTOUCH: -                        func = device->input_aftertouch_callback; -                        break; -                    case MIDI_PITCHBEND: -                        func = device->input_pitchbend_callback; -                        break; -                    case 0xF0: -                        if (byte0 == MIDI_SONGPOSITION) func = device->input_songposition_callback; -                        break; -                    default: -                        break; -                } -                if (func) { -                    // mask off the channel for non song position functions -                    if (byte0 == MIDI_SONGPOSITION) -                        func(device, byte0, byte1, byte2); -                    else -                        func(device, byte0 & 0x0F, byte1, byte2); -                    called = true; -                } -            } break; -            case 2: { -                midi_two_byte_func_t func = NULL; -                switch (byte0 & 0xF0) { -                    case MIDI_PROGCHANGE: -                        func = device->input_progchange_callback; -                        break; -                    case MIDI_CHANPRESSURE: -                        func = device->input_chanpressure_callback; -                        break; -                    case 0xF0: -                        if (byte0 == MIDI_SONGSELECT) -                            func = device->input_songselect_callback; -                        else if (byte0 == MIDI_TC_QUARTERFRAME) -                            func = device->input_tc_quarterframe_callback; -                        break; -                    default: -                        break; -                } -                if (func) { -                    // mask off the channel -                    if (byte0 == MIDI_SONGSELECT || byte0 == MIDI_TC_QUARTERFRAME) -                        func(device, byte0, byte1); -                    else -                        func(device, byte0 & 0x0F, byte1); -                    called = true; -                } -            } break; -            case 1: { -                midi_one_byte_func_t func = NULL; -                if (midi_is_realtime(byte0)) -                    func = device->input_realtime_callback; -                else if (byte0 == MIDI_TUNEREQUEST) -                    func = device->input_tunerequest_callback; -                if (func) { -                    func(device, byte0); -                    called = true; -                } -            } break; -            default: -                // just in case -                if (cnt > 3) cnt = 0; -                break; -        } -    } - -    // if there is fallthrough default callback and we haven't called a more specific one, -    // call the fallthrough -    if (!called && device->input_fallthrough_callback) device->input_fallthrough_callback(device, cnt, byte0, byte1, byte2); -    // always call the catch all if it exists -    if (device->input_catchall_callback) device->input_catchall_callback(device, cnt, byte0, byte1, byte2); -} diff --git a/tmk_core/protocol/midi/midi_device.h b/tmk_core/protocol/midi/midi_device.h deleted file mode 100644 index 79e8f7a936..0000000000 --- a/tmk_core/protocol/midi/midi_device.h +++ /dev/null @@ -1,148 +0,0 @@ -// midi for embedded chips, -// Copyright 2010 Alex Norman -// -// This file is part of avr-midi. -// -// avr-midi is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-midi is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-midi.  If not, see <http://www.gnu.org/licenses/>. - -/** - * @file - * @brief Device implementation functions - */ - -#pragma once - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * @defgroup midi_device Functions used when implementing your own midi device. - * - * You use the functions when you are implementing your own midi device. - * - * You set a send function to actually send bytes via your device, this method - * is called when you call a send function with this device, for instance - * midi_send_cc - * - * You use the midi_device_input to process input data from the device and pass - * it through the device's associated callbacks. - * - * You use the midi_device_set_pre_input_process_func if you want to have a - * function called at the beginning of the device's process function, generally - * to poll for input and pass that into midi_device_input - * - * @{ - */ - -#include "midi_function_types.h" -#include "bytequeue/bytequeue.h" -#define MIDI_INPUT_QUEUE_LENGTH 192 - -typedef enum { IDLE, ONE_BYTE_MESSAGE = 1, TWO_BYTE_MESSAGE = 2, THREE_BYTE_MESSAGE = 3, SYSEX_MESSAGE } input_state_t; - -typedef void (*midi_no_byte_func_t)(MidiDevice* device); - -/** - * \struct _midi_device - * - * @brief This structure represents the input and output functions and - * processing data for a midi device. - * - * A device can represent an actual physical device [serial port, usb port] or - * something virtual. - * You should not need to modify this structure directly. - */ -struct _midi_device { -    // output send function -    midi_var_byte_func_t send_func; - -    //********input callbacks -    // three byte funcs -    midi_three_byte_func_t input_cc_callback; -    midi_three_byte_func_t input_noteon_callback; -    midi_three_byte_func_t input_noteoff_callback; -    midi_three_byte_func_t input_aftertouch_callback; -    midi_three_byte_func_t input_pitchbend_callback; -    midi_three_byte_func_t input_songposition_callback; -    // two byte funcs -    midi_two_byte_func_t input_progchange_callback; -    midi_two_byte_func_t input_chanpressure_callback; -    midi_two_byte_func_t input_songselect_callback; -    midi_two_byte_func_t input_tc_quarterframe_callback; -    // one byte funcs -    midi_one_byte_func_t input_realtime_callback; -    midi_one_byte_func_t input_tunerequest_callback; - -    // sysex -    midi_sysex_func_t input_sysex_callback; - -    // only called if more specific callback is not matched -    midi_var_byte_func_t input_fallthrough_callback; -    // called if registered, independent of other callbacks -    midi_var_byte_func_t input_catchall_callback; - -    // pre input processing function -    midi_no_byte_func_t pre_input_process_callback; - -    // for internal input processing -    uint8_t       input_buffer[3]; -    input_state_t input_state; -    uint16_t      input_count; - -    // for queueing data between the input and the processing functions -    uint8_t     input_queue_data[MIDI_INPUT_QUEUE_LENGTH]; -    byteQueue_t input_queue; -}; - -/** - * @brief Process input bytes.  This function parses bytes and calls the - * appropriate callbacks associated with the given device.  You use this - * function if you are creating a custom device and you want to have midi - * input. - * - * @param device the midi device to associate the input with - * @param cnt the number of bytes you are processing - * @param input the bytes to process - */ -void midi_device_input(MidiDevice* device, uint8_t cnt, uint8_t* input); - -/** - * @brief Set the callback function that will be used for sending output - * data bytes.  This is only used if you're creating a custom device. - * You'll most likely want the callback function to disable interrupts so - * that you can call the various midi send functions without worrying about - * locking. - * - * \param device the midi device to associate this callback with - * \param send_func the callback function that will do the sending - */ -void midi_device_set_send_func(MidiDevice* device, midi_var_byte_func_t send_func); - -/** - * @brief Set a callback which is called at the beginning of the - * midi_device_process call.  This can be used to poll for input - * data and send the data through the midi_device_input function. - * You'll probably only use this if you're creating a custom device. - * - * \param device the midi device to associate this callback with - * \param midi_no_byte_func_t the actual callback function - */ -void midi_device_set_pre_input_process_func(MidiDevice* device, midi_no_byte_func_t pre_process_func); - -/**@}*/ - -#ifdef __cplusplus -} -#endif diff --git a/tmk_core/protocol/midi/midi_function_types.h b/tmk_core/protocol/midi/midi_function_types.h deleted file mode 100644 index 6f98a72981..0000000000 --- a/tmk_core/protocol/midi/midi_function_types.h +++ /dev/null @@ -1,47 +0,0 @@ -// midi for embedded chips, -// Copyright 2010 Alex Norman -// -// This file is part of avr-midi. -// -// avr-midi is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-midi is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-midi.  If not, see <http://www.gnu.org/licenses/>. - -/** - * @file - * @brief Function signature definitions - */ - -#pragma once - -#ifdef __cplusplus -extern "C" { -#endif - -#include <inttypes.h> -#include <stdbool.h> - -// forward declaration -typedef struct _midi_device MidiDevice; - -typedef void (*midi_one_byte_func_t)(MidiDevice *device, uint8_t byte); -typedef void (*midi_two_byte_func_t)(MidiDevice *device, uint8_t byte0, uint8_t byte1); -typedef void (*midi_three_byte_func_t)(MidiDevice *device, uint8_t byte0, uint8_t byte1, uint8_t byte2); -// all bytes after count bytes should be ignored -typedef void (*midi_var_byte_func_t)(MidiDevice *device, uint16_t count, uint8_t byte0, uint8_t byte1, uint8_t byte2); - -// the start byte tells you how far into the sysex message you are, the data_length tells you how many bytes data is -typedef void (*midi_sysex_func_t)(MidiDevice *device, uint16_t start_byte, uint8_t data_length, uint8_t *data); - -#ifdef __cplusplus -} -#endif diff --git a/tmk_core/protocol/midi/qmk_midi.c b/tmk_core/protocol/midi/qmk_midi.c deleted file mode 100644 index f6a5d92281..0000000000 --- a/tmk_core/protocol/midi/qmk_midi.c +++ /dev/null @@ -1,135 +0,0 @@ -#include <LUFA/Drivers/USB/USB.h> -#include "qmk_midi.h" -#include "sysex_tools.h" -#include "midi.h" -#include "usb_descriptor.h" -#include "process_midi.h" - -/******************************************************************************* - * MIDI - ******************************************************************************/ - -MidiDevice midi_device; - -#define SYSEX_START_OR_CONT 0x40 -#define SYSEX_ENDS_IN_1 0x50 -#define SYSEX_ENDS_IN_2 0x60 -#define SYSEX_ENDS_IN_3 0x70 - -#define SYS_COMMON_1 0x50 -#define SYS_COMMON_2 0x20 -#define SYS_COMMON_3 0x30 - -static void usb_send_func(MidiDevice* device, uint16_t cnt, uint8_t byte0, uint8_t byte1, uint8_t byte2) { -    MIDI_EventPacket_t event; -    event.Data1 = byte0; -    event.Data2 = byte1; -    event.Data3 = byte2; - -    uint8_t cable = 0; - -    // if the length is undefined we assume it is a SYSEX message -    if (midi_packet_length(byte0) == UNDEFINED) { -        switch (cnt) { -            case 3: -                if (byte2 == SYSEX_END) -                    event.Event = MIDI_EVENT(cable, SYSEX_ENDS_IN_3); -                else -                    event.Event = MIDI_EVENT(cable, SYSEX_START_OR_CONT); -                break; -            case 2: -                if (byte1 == SYSEX_END) -                    event.Event = MIDI_EVENT(cable, SYSEX_ENDS_IN_2); -                else -                    event.Event = MIDI_EVENT(cable, SYSEX_START_OR_CONT); -                break; -            case 1: -                if (byte0 == SYSEX_END) -                    event.Event = MIDI_EVENT(cable, SYSEX_ENDS_IN_1); -                else -                    event.Event = MIDI_EVENT(cable, SYSEX_START_OR_CONT); -                break; -            default: -                return; // invalid cnt -        } -    } else { -        // deal with 'system common' messages -        // TODO are there any more? -        switch (byte0 & 0xF0) { -            case MIDI_SONGPOSITION: -                event.Event = MIDI_EVENT(cable, SYS_COMMON_3); -                break; -            case MIDI_SONGSELECT: -            case MIDI_TC_QUARTERFRAME: -                event.Event = MIDI_EVENT(cable, SYS_COMMON_2); -                break; -            default: -                event.Event = MIDI_EVENT(cable, byte0); -                break; -        } -    } - -    send_midi_packet(&event); -} - -static void usb_get_midi(MidiDevice* device) { -    MIDI_EventPacket_t event; -    while (recv_midi_packet(&event)) { -        midi_packet_length_t length = midi_packet_length(event.Data1); -        uint8_t              input[3]; -        input[0] = event.Data1; -        input[1] = event.Data2; -        input[2] = event.Data3; -        if (length == UNDEFINED) { -            // sysex -            if (event.Event == MIDI_EVENT(0, SYSEX_START_OR_CONT) || event.Event == MIDI_EVENT(0, SYSEX_ENDS_IN_3)) { -                length = 3; -            } else if (event.Event == MIDI_EVENT(0, SYSEX_ENDS_IN_2)) { -                length = 2; -            } else if (event.Event == MIDI_EVENT(0, SYSEX_ENDS_IN_1)) { -                length = 1; -            } else { -                // XXX what to do? -            } -        } - -        // pass the data to the device input function -        if (length != UNDEFINED) midi_device_input(device, length, input); -    } -} - -static void fallthrough_callback(MidiDevice* device, uint16_t cnt, uint8_t byte0, uint8_t byte1, uint8_t byte2) { -#ifdef AUDIO_ENABLE -    if (cnt == 3) { -        switch (byte0 & 0xF0) { -            case MIDI_NOTEON: -                play_note(((double)261.6) * pow(2.0, -4.0) * pow(2.0, (byte1 & 0x7F) / 12.0), (byte2 & 0x7F) / 8); -                break; -            case MIDI_NOTEOFF: -                stop_note(((double)261.6) * pow(2.0, -4.0) * pow(2.0, (byte1 & 0x7F) / 12.0)); -                break; -        } -    } -    if (byte0 == MIDI_STOP) { -        stop_all_notes(); -    } -#endif -} - -static void cc_callback(MidiDevice* device, uint8_t chan, uint8_t num, uint8_t val) { -    // sending it back on the next channel -    // midi_send_cc(device, (chan + 1) % 16, num, val); -} - -void midi_init(void); - -void setup_midi(void) { -#ifdef MIDI_ADVANCED -    midi_init(); -#endif -    midi_device_init(&midi_device); -    midi_device_set_send_func(&midi_device, usb_send_func); -    midi_device_set_pre_input_process_func(&midi_device, usb_get_midi); -    midi_register_fallthrough_callback(&midi_device, fallthrough_callback); -    midi_register_cc_callback(&midi_device, cc_callback); -} diff --git a/tmk_core/protocol/midi/qmk_midi.h b/tmk_core/protocol/midi/qmk_midi.h deleted file mode 100644 index 819087a405..0000000000 --- a/tmk_core/protocol/midi/qmk_midi.h +++ /dev/null @@ -1,10 +0,0 @@ -#pragma once - -#ifdef MIDI_ENABLE -#    include "midi.h" -#    include <LUFA/Drivers/USB/USB.h> -extern MidiDevice midi_device; -void              setup_midi(void); -void              send_midi_packet(MIDI_EventPacket_t* event); -bool              recv_midi_packet(MIDI_EventPacket_t* const event); -#endif diff --git a/tmk_core/protocol/midi/sysex_tools.c b/tmk_core/protocol/midi/sysex_tools.c deleted file mode 100644 index c9a9d03285..0000000000 --- a/tmk_core/protocol/midi/sysex_tools.c +++ /dev/null @@ -1,97 +0,0 @@ -// midi for embedded chips, -// Copyright 2010 Alex Norman -// -// This file is part of avr-midi. -// -// avr-midi is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-midi is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-midi.  If not, see <http://www.gnu.org/licenses/>. - -#include "sysex_tools.h" - -uint16_t sysex_encoded_length(uint16_t decoded_length) { -    uint8_t remainder = decoded_length % 7; -    if (remainder) -        return (decoded_length / 7) * 8 + remainder + 1; -    else -        return (decoded_length / 7) * 8; -} - -uint16_t sysex_decoded_length(uint16_t encoded_length) { -    uint8_t remainder = encoded_length % 8; -    if (remainder) -        return (encoded_length / 8) * 7 + remainder - 1; -    else -        return (encoded_length / 8) * 7; -} - -uint16_t sysex_encode(uint8_t *encoded, const uint8_t *source, const uint16_t length) { -    uint16_t encoded_full = length / 7; // number of full 8 byte sections from 7 bytes of input -    uint16_t i, j; - -    // fill out the fully encoded sections -    for (i = 0; i < encoded_full; i++) { -        uint16_t encoded_msb_idx = i * 8; -        uint16_t input_start_idx = i * 7; -        encoded[encoded_msb_idx] = 0; -        for (j = 0; j < 7; j++) { -            uint8_t current = source[input_start_idx + j]; -            encoded[encoded_msb_idx] |= (0x80 & current) >> (1 + j); -            encoded[encoded_msb_idx + 1 + j] = 0x7F & current; -        } -    } - -    // fill out the rest if there is any more -    uint8_t remainder = length % 7; -    if (remainder) { -        uint16_t encoded_msb_idx = encoded_full * 8; -        uint16_t input_start_idx = encoded_full * 7; -        encoded[encoded_msb_idx] = 0; -        for (j = 0; j < remainder; j++) { -            uint8_t current = source[input_start_idx + j]; -            encoded[encoded_msb_idx] |= (0x80 & current) >> (1 + j); -            encoded[encoded_msb_idx + 1 + j] = 0x7F & current; -        } -        return encoded_msb_idx + remainder + 1; -    } else { -        return encoded_full * 8; -    } -} - -uint16_t sysex_decode(uint8_t *decoded, const uint8_t *source, const uint16_t length) { -    uint16_t decoded_full = length / 8; -    uint16_t i, j; - -    if (length < 2) return 0; - -    // fill out the fully encoded sections -    for (i = 0; i < decoded_full; i++) { -        uint16_t encoded_msb_idx    = i * 8; -        uint16_t output_start_index = i * 7; -        for (j = 0; j < 7; j++) { -            decoded[output_start_index + j] = 0x7F & source[encoded_msb_idx + j + 1]; -            decoded[output_start_index + j] |= (0x80 & (source[encoded_msb_idx] << (1 + j))); -        } -    } -    uint8_t remainder = length % 8; -    if (remainder) { -        uint16_t encoded_msb_idx    = decoded_full * 8; -        uint16_t output_start_index = decoded_full * 7; -        for (j = 0; j < (remainder - 1); j++) { -            decoded[output_start_index + j] = 0x7F & source[encoded_msb_idx + j + 1]; -            decoded[output_start_index + j] |= (0x80 & (source[encoded_msb_idx] << (1 + j))); -        } -        return decoded_full * 7 + remainder - 1; -    } else { -        return decoded_full * 7; -    } -} diff --git a/tmk_core/protocol/midi/sysex_tools.h b/tmk_core/protocol/midi/sysex_tools.h deleted file mode 100644 index 7d7f10d24e..0000000000 --- a/tmk_core/protocol/midi/sysex_tools.h +++ /dev/null @@ -1,92 +0,0 @@ -// midi for embedded chips, -// Copyright 2010 Alex Norman -// -// This file is part of avr-midi. -// -// avr-midi is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -//(at your option) any later version. -// -// avr-midi is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with avr-midi.  If not, see <http://www.gnu.org/licenses/>. - -#pragma once - -#ifdef __cplusplus -extern "C" { -#endif - -#include <inttypes.h> - -/** - * @file - * @brief Sysex utility functions - * - * These functions are for converting data to and from a "midi-safe" format, - * which can be use to send data with sysex messages.  Sysex messages may only - * contain data where the to bit is not set. - * - * An "encoded" midi message is one that contains all of the data from its - * original state, but does not have any of the top bits set. - * - * Every 7 bytes of decoded data is converted into 8 bytes of encoded data and - * visa-versa.  If you'd like to operate on small segments, make sure that you - * encode in 7 byte increments and decode in 8 byte increments. - * - */ - -/** @defgroup sysex_tools Sysex utility functions - * @{ - */ - -/** - * @brief Compute the length of a message after it is encoded. - * - * @param decoded_length The length, in bytes, of the message to encode. - * - * @return The length, in bytes, of the message after encodeing. - */ -uint16_t sysex_encoded_length(uint16_t decoded_length); - -/** - * @brief Compute the length of a message after it is decoded. - * - * @param encoded_length The length, in bytes, of the encoded message. - * - * @return The length, in bytes, of the message after it is decoded. - */ -uint16_t sysex_decoded_length(uint16_t encoded_length); - -/** - * @brief Encode data so that it can be transmitted safely in a sysex message. - * - * @param encoded The output data buffer, must be at least sysex_encoded_length(length) bytes long. - * @param source The input buffer of data to be encoded. - * @param length The number of bytes from the input buffer to encode. - * - * @return number of bytes encoded. - */ -uint16_t sysex_encode(uint8_t *encoded, const uint8_t *source, uint16_t length); - -/** - * @brief Decode encoded data. - * - * @param decoded The output data buffer, must be at least sysex_decoded_length(length) bytes long. - * @param source The input buffer of data to be decoded. - * @param length The number of bytes from the input buffer to decode. - * - * @return number of bytes decoded. - */ -uint16_t sysex_decode(uint8_t *decoded, const uint8_t *source, uint16_t length); - -/**@}*/ - -#ifdef __cplusplus -} -#endif diff --git a/tmk_core/protocol/usb_descriptor.c b/tmk_core/protocol/usb_descriptor.c index 99c52952a0..5ab9e3ff4f 100644 --- a/tmk_core/protocol/usb_descriptor.c +++ b/tmk_core/protocol/usb_descriptor.c @@ -45,8 +45,9 @@  #    include "joystick.h"  #endif -// TODO: wb32 support defines ISO macro which breaks PRODUCT stringification -#undef ISO +#ifdef OS_DETECTION_ENABLE +#    include "os_detection.h" +#endif  // clang-format off @@ -1095,7 +1096,7 @@ const USB_Descriptor_String_t PROGMEM SerialNumberString = {   * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the   * USB host.   */ -uint16_t get_usb_descriptor(const uint16_t wValue, const uint16_t wIndex, const void** const DescriptorAddress) { +uint16_t get_usb_descriptor(const uint16_t wValue, const uint16_t wIndex, const uint16_t wLength, const void** const DescriptorAddress) {      const uint8_t DescriptorType  = (wValue >> 8);      const uint8_t DescriptorIndex = (wValue & 0xFF);      const void*   Address         = NULL; @@ -1137,6 +1138,9 @@ uint16_t get_usb_descriptor(const uint16_t wValue, const uint16_t wIndex, const                      break;  #endif              } +#ifdef OS_DETECTION_ENABLE +            process_wlength(wLength); +#endif              break;          case HID_DTYPE_HID: diff --git a/tmk_core/protocol/usb_descriptor.h b/tmk_core/protocol/usb_descriptor.h index bc5e84e586..ed84f4c9ab 100644 --- a/tmk_core/protocol/usb_descriptor.h +++ b/tmk_core/protocol/usb_descriptor.h @@ -308,4 +308,4 @@ enum usb_endpoints {  #define JOYSTICK_EPSIZE 8  #define DIGITIZER_EPSIZE 8 -uint16_t get_usb_descriptor(const uint16_t wValue, const uint16_t wIndex, const void** const DescriptorAddress); +uint16_t get_usb_descriptor(const uint16_t wValue, const uint16_t wIndex, const uint16_t wLength, const void** const DescriptorAddress); diff --git a/tmk_core/protocol/vusb/vusb.c b/tmk_core/protocol/vusb/vusb.c index 2d17761978..b3eeff9e01 100644 --- a/tmk_core/protocol/vusb/vusb.c +++ b/tmk_core/protocol/vusb/vusb.c @@ -44,6 +44,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.  #    include "ring_buffer.h"  #endif +#ifdef OS_DETECTION_ENABLE +#    include "os_detection.h" +#endif +  #define NEXT_INTERFACE __COUNTER__  /* @@ -1013,6 +1017,9 @@ USB_PUBLIC usbMsgLen_t usbFunctionDescriptor(struct usbRequest *rq) {                      break;  #endif              } +#ifdef OS_DETECTION_ENABLE +            process_wlength(rq->wLength.word); +#endif              break;          case USBDESCR_HID:              switch (rq->wValue.bytes[0]) { | 
