Code cleanup

- Changing header file ifndef define to pragma once's
- Removed duplicate output_com.h's
This commit is contained in:
Jacob Alexander 2015-06-14 13:56:56 -07:00
parent 03f60df94d
commit 5f262ea4b6
75 changed files with 158 additions and 650 deletions

View file

@ -1,7 +1,7 @@
/* Teensyduino Core Library
* http://www.pjrc.com/teensy/
* Copyright (c) 2013 PJRC.COM, LLC.
* Modified by Jacob Alexander (2013-2014)
* Modified by Jacob Alexander (2013-2015)
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
@ -29,8 +29,7 @@
* SOFTWARE.
*/
#ifndef _usb_desc_h_
#define _usb_desc_h_
#pragma once
// ----- Includes -----
@ -126,6 +125,3 @@ extern const uint8_t usb_endpoint_config_table[NUM_ENDPOINTS];
extern const usb_descriptor_list_t usb_descriptor_list[];
#endif

View file

@ -1,7 +1,7 @@
/* Teensyduino Core Library
* http://www.pjrc.com/teensy/
* Copyright (c) 2013 PJRC.COM, LLC.
* Modifications by Jacob Alexander 2014
* Modifications by Jacob Alexander 2014-2015
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
@ -29,8 +29,7 @@
* SOFTWARE.
*/
#ifndef _usb_dev_h_
#define _usb_dev_h_
#pragma once
// ----- Includes -----
@ -87,7 +86,3 @@ void usb_device_reload();
extern void usb_serial_flush_callback();
#endif

View file

@ -1,7 +1,7 @@
/* Teensyduino Core Library
* http://www.pjrc.com/teensy/
* Copyright (c) 2013 PJRC.COM, LLC.
* Modifications by Jacob Alexander 2013-2014
* Modifications by Jacob Alexander 2013-2015
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
@ -29,8 +29,7 @@
* SOFTWARE.
*/
#ifndef USBkeyboard_h_
#define USBkeyboard_h_
#pragma once
// ----- Includes -----
@ -46,7 +45,3 @@
void usb_keyboard_send();
#endif // USBkeyboard_h_

View file

@ -1,7 +1,7 @@
/* Teensyduino Core Library
* http://www.pjrc.com/teensy/
* Copyright (c) 2013 PJRC.COM, LLC.
* Modifications by Jacob Alexander (2013-2014)
* Modifications by Jacob Alexander (2013-2015)
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
@ -29,8 +29,7 @@
* SOFTWARE.
*/
#ifndef _usb_mem_h_
#define _usb_mem_h_
#pragma once
// ----- Includes -----
@ -55,7 +54,3 @@ typedef struct usb_packet_struct {
usb_packet_t *usb_malloc();
void usb_free( usb_packet_t *p );
#endif

View file

@ -1,7 +1,7 @@
/* Teensyduino Core Library
* http://www.pjrc.com/teensy/
* Copyright (c) 2013 PJRC.COM, LLC.
* Modifications by Jacob Alexander (2013-2014)
* Modifications by Jacob Alexander (2013-2015)
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
@ -29,8 +29,7 @@
* SOFTWARE.
*/
#ifndef USBserial_h_
#define USBserial_h_
#pragma once
// ----- Includes -----
@ -73,7 +72,3 @@ int usb_serial_write( const void *buffer, uint32_t size );
void usb_serial_flush_input();
void usb_serial_flush_output();
#endif // USBserial_h_

View file

@ -1,6 +1,6 @@
/* USB Keyboard and CDC Serial Device for Teensy USB Development Board
* Copyright (c) 2009 PJRC.COM, LLC
* Modifications by Jacob Alexander (2011-2014)
* Modifications by Jacob Alexander (2011-2015)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
@ -21,8 +21,7 @@
* THE SOFTWARE.
*/
#ifndef usb_keyboard_serial_h__
#define usb_keyboard_serial_h__
#pragma once
// ----- Includes -----
@ -701,7 +700,3 @@ static const struct descriptor_list_struct {
};
#define NUM_DESC_LIST (sizeof(descriptor_list)/sizeof(struct descriptor_list_struct))
#endif // usb_keyboard_serial_h__

View file

@ -19,8 +19,7 @@
* THE SOFTWARE.
*/
#ifndef __output_com_h
#define __output_com_h
#pragma once
// ----- Includes -----
@ -116,5 +115,3 @@ int Output_getchar();
int Output_putchar( char c );
int Output_putstr( char* str );
#endif

View file

@ -1,4 +1,4 @@
/* Copyright (C) 2014 by Jacob Alexander
/* Copyright (C) 2014-2015 by Jacob Alexander
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
@ -19,8 +19,7 @@
* THE SOFTWARE.
*/
#ifndef __uart_serial_h_
#define __uart_serial_h_
#pragma once
#include <inttypes.h>
@ -36,5 +35,3 @@ void uart_serial_setup();
void uart_device_reload();
#endif // __uart_serial_h_

View file

@ -1,105 +0,0 @@
/* Copyright (C) 2013-2015 by Jacob Alexander
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#ifndef __output_com_h
#define __output_com_h
// ----- Includes -----
// Compiler Includes
#include <stdint.h>
// Local Includes
#include <buildvars.h> // Defines USB Parameters, partially generated by CMake
// ----- Defines -----
// Max size of key buffer needed for NKRO
// Boot mode uses only the first 6 bytes
#define USB_NKRO_BITFIELD_SIZE_KEYS 26
#define USB_BOOT_MAX_KEYS 6
// ----- Enumerations -----
// USB NKRO state transitions (indicates which Report ID's need refreshing)
// Boot mode just checks if any keys were changed (as everything is sent every time)
typedef enum USBKeyChangeState {
USBKeyChangeState_None = 0x00,
USBKeyChangeState_Modifiers = 0x01,
USBKeyChangeState_MainKeys = 0x02,
USBKeyChangeState_SecondaryKeys = 0x04,
USBKeyChangeState_System = 0x08,
USBKeyChangeState_Consumer = 0x10,
} USBKeyChangeState;
// ----- Variables -----
// Variables used to communciate to the output module
// XXX Even if the output module is not USB, this is internally understood keymapping scheme
extern uint8_t USBKeys_Modifiers;
extern uint8_t USBKeys_Keys[USB_NKRO_BITFIELD_SIZE_KEYS];
extern uint8_t USBKeys_Sent;
extern volatile uint8_t USBKeys_LEDs;
extern uint8_t USBKeys_SysCtrl; // 1KRO container for System Control HID table
extern uint16_t USBKeys_ConsCtrl; // 1KRO container for Consumer Control HID table
extern volatile uint8_t USBKeys_Protocol; // 0 - Boot Mode, 1 - NKRO Mode
// Misc variables (XXX Some are only properly utilized using AVR)
extern uint8_t USBKeys_Idle_Config;
extern uint8_t USBKeys_Idle_Count;
extern USBKeyChangeState USBKeys_Changed;
extern uint8_t Output_Available; // 0 - Output module not fully functional, 1 - Output module working
// ----- Capabilities -----
void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
// ----- Functions -----
void Output_setup();
void Output_send();
void Output_firmwareReload();
void Output_softReset();
// Relies on USB serial module
unsigned int Output_availablechar();
int Output_getchar();
int Output_putchar( char c );
int Output_putstr( char* str );
#endif

View file

@ -30,6 +30,16 @@ elseif ( ${COMPILER_FAMILY} MATCHES "arm" )
endif ()
###
# Includes
#
# Use pjrcUSB output_com.h
include_directories (
${CMAKE_CURRENT_LIST_DIR}/../pjrcUSB
)
###
# Compiler Family Compatibility
#

View file

@ -1,119 +0,0 @@
/* Copyright (C) 2013-2015 by Jacob Alexander
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#ifndef __output_com_h
#define __output_com_h
// ----- Includes -----
// Compiler Includes
#include <stdint.h>
// Local Includes
#include <buildvars.h> // Defines USB Parameters, partially generated by CMake
// ----- Defines -----
// Max size of key buffer needed for NKRO
// Boot mode uses only the first 6 bytes
#define USB_NKRO_BITFIELD_SIZE_KEYS 27
#define USB_BOOT_MAX_KEYS 6
// ----- Enumerations -----
// USB NKRO state transitions (indicates which Report ID's need refreshing)
// Boot mode just checks if any keys were changed (as everything is sent every time)
typedef enum USBKeyChangeState {
USBKeyChangeState_None = 0x00,
USBKeyChangeState_Modifiers = 0x01,
USBKeyChangeState_MainKeys = 0x02,
USBKeyChangeState_SecondaryKeys = 0x04,
USBKeyChangeState_TertiaryKeys = 0x08,
USBKeyChangeState_QuartiaryKeys = 0x10,
USBKeyChangeState_System = 0x20,
USBKeyChangeState_Consumer = 0x40,
USBKeyChangeState_All = 0x7F,
} USBKeyChangeState;
// ----- Variables -----
// Variables used to communciate to the output module
// XXX Even if the output module is not USB, this is internally understood keymapping scheme
extern uint8_t USBKeys_Modifiers;
extern uint8_t USBKeys_Keys[USB_NKRO_BITFIELD_SIZE_KEYS];
extern uint8_t USBKeys_Sent;
extern volatile uint8_t USBKeys_LEDs;
extern uint8_t USBKeys_SysCtrl; // 1KRO container for System Control HID table
extern uint16_t USBKeys_ConsCtrl; // 1KRO container for Consumer Control HID table
extern volatile uint8_t USBKeys_Protocol; // 0 - Boot Mode, 1 - NKRO Mode
// Misc variables (XXX Some are only properly utilized using AVR)
extern uint8_t USBKeys_Idle_Config;
extern uint8_t USBKeys_Idle_Count;
extern USBKeyChangeState USBKeys_Changed;
extern uint8_t Output_Available; // 0 - Output module not fully functional, 1 - Output module working
extern uint8_t Output_DebugMode; // 0 - Debug disabled, 1 - Debug enabled
// ----- Capabilities -----
void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
void Output_noneSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
// Configuration capabilities
void Output_kbdProtocolBoot_capability( uint8_t state, uint8_t stateType, uint8_t *args );
void Output_kbdProtocolNKRO_capability( uint8_t state, uint8_t stateType, uint8_t *args );
// ----- Functions -----
void Output_setup();
void Output_send();
void Output_flushBuffers();
void Output_firmwareReload();
void Output_softReset();
// Relies on USB serial module
unsigned int Output_availablechar();
int Output_getchar();
int Output_putchar( char c );
int Output_putstr( char* str );
#endif