mirror of
https://github.com/portapack-mayhem/mayhem-firmware.git
synced 2024-12-19 06:27:44 +00:00
242 lines
8.6 KiB
C
242 lines
8.6 KiB
C
|
/*
|
||
|
|
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
|
||
|
|
2011,2012,2013 Giovanni Di Sirio.
|
||
|
|
|
||
|
|
This file is part of ChibiOS/RT.
|
||
|
|
|
||
|
|
ChibiOS/RT 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.
|
||
|
|
|
||
|
|
ChibiOS/RT 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/>.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
A special exception to the GPL can be applied should you wish to distribute
|
||
|
|
a combined work that includes ChibiOS/RT, without being obliged to provide
|
||
|
|
the source code for any proprietary components. See the file exception.txt
|
||
|
|
for full details of how and when the exception can be applied.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @file serial_usb.h
|
||
|
|
* @brief Serial over USB Driver macros and structures.
|
||
|
|
*
|
||
|
|
* @addtogroup SERIAL_USB
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef _SERIAL_USB_H_
|
||
|
|
#define _SERIAL_USB_H_
|
||
|
|
|
||
|
|
#if HAL_USE_SERIAL_USB || defined(__DOXYGEN__)
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Driver constants. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name CDC specific messages.
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
#define CDC_SEND_ENCAPSULATED_COMMAND 0x00
|
||
|
|
#define CDC_GET_ENCAPSULATED_RESPONSE 0x01
|
||
|
|
#define CDC_SET_COMM_FEATURE 0x02
|
||
|
|
#define CDC_GET_COMM_FEATURE 0x03
|
||
|
|
#define CDC_CLEAR_COMM_FEATURE 0x04
|
||
|
|
#define CDC_SET_AUX_LINE_STATE 0x10
|
||
|
|
#define CDC_SET_HOOK_STATE 0x11
|
||
|
|
#define CDC_PULSE_SETUP 0x12
|
||
|
|
#define CDC_SEND_PULSE 0x13
|
||
|
|
#define CDC_SET_PULSE_TIME 0x14
|
||
|
|
#define CDC_RING_AUX_JACK 0x15
|
||
|
|
#define CDC_SET_LINE_CODING 0x20
|
||
|
|
#define CDC_GET_LINE_CODING 0x21
|
||
|
|
#define CDC_SET_CONTROL_LINE_STATE 0x22
|
||
|
|
#define CDC_SEND_BREAK 0x23
|
||
|
|
#define CDC_SET_RINGER_PARMS 0x30
|
||
|
|
#define CDC_GET_RINGER_PARMS 0x31
|
||
|
|
#define CDC_SET_OPERATION_PARMS 0x32
|
||
|
|
#define CDC_GET_OPERATION_PARMS 0x33
|
||
|
|
/** @} */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name Line Control bit definitions.
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
#define LC_STOP_1 0
|
||
|
|
#define LC_STOP_1P5 1
|
||
|
|
#define LC_STOP_2 2
|
||
|
|
|
||
|
|
#define LC_PARITY_NONE 0
|
||
|
|
#define LC_PARITY_ODD 1
|
||
|
|
#define LC_PARITY_EVEN 2
|
||
|
|
#define LC_PARITY_MARK 3
|
||
|
|
#define LC_PARITY_SPACE 4
|
||
|
|
/** @} */
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Driver pre-compile time settings. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name SERIAL_USB configuration options
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @brief Serial over USB buffers size.
|
||
|
|
* @details Configuration parameter, the buffer size must be a multiple of
|
||
|
|
* the USB data endpoint maximum packet size.
|
||
|
|
* @note The default is 256 bytes for both the transmission and receive
|
||
|
|
* buffers.
|
||
|
|
*/
|
||
|
|
#if !defined(SERIAL_USB_BUFFERS_SIZE) || defined(__DOXYGEN__)
|
||
|
|
#define SERIAL_USB_BUFFERS_SIZE 256
|
||
|
|
#endif
|
||
|
|
/** @} */
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Derived constants and error checks. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
#if !HAL_USE_USB || !CH_USE_QUEUES || !CH_USE_EVENTS
|
||
|
|
#error "Serial over USB Driver requires HAL_USE_USB, CH_USE_QUEUES, "
|
||
|
|
"CH_USE_EVENTS"
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Driver data structures and types. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Type of Line Coding structure.
|
||
|
|
*/
|
||
|
|
typedef struct {
|
||
|
|
uint8_t dwDTERate[4];
|
||
|
|
uint8_t bCharFormat;
|
||
|
|
uint8_t bParityType;
|
||
|
|
uint8_t bDataBits;
|
||
|
|
} cdc_linecoding_t;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Driver state machine possible states.
|
||
|
|
*/
|
||
|
|
typedef enum {
|
||
|
|
SDU_UNINIT = 0, /**< Not initialized. */
|
||
|
|
SDU_STOP = 1, /**< Stopped. */
|
||
|
|
SDU_READY = 2 /**< Ready. */
|
||
|
|
} sdustate_t;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Structure representing a serial over USB driver.
|
||
|
|
*/
|
||
|
|
typedef struct SerialUSBDriver SerialUSBDriver;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Serial over USB Driver configuration structure.
|
||
|
|
* @details An instance of this structure must be passed to @p sduStart()
|
||
|
|
* in order to configure and start the driver operations.
|
||
|
|
*/
|
||
|
|
typedef struct {
|
||
|
|
/**
|
||
|
|
* @brief USB driver to use.
|
||
|
|
*/
|
||
|
|
USBDriver *usbp;
|
||
|
|
/**
|
||
|
|
* @brief Bulk IN endpoint used for outgoing data transfer.
|
||
|
|
*/
|
||
|
|
usbep_t bulk_in;
|
||
|
|
/**
|
||
|
|
* @brief Bulk OUT endpoint used for incoming data transfer.
|
||
|
|
*/
|
||
|
|
usbep_t bulk_out;
|
||
|
|
/**
|
||
|
|
* @brief Interrupt IN endpoint used for notifications.
|
||
|
|
*/
|
||
|
|
usbep_t int_in;
|
||
|
|
} SerialUSBConfig;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief @p SerialDriver specific data.
|
||
|
|
*/
|
||
|
|
#define _serial_usb_driver_data \
|
||
|
|
_base_asynchronous_channel_data \
|
||
|
|
/* Driver state.*/ \
|
||
|
|
sdustate_t state; \
|
||
|
|
/* Input queue.*/ \
|
||
|
|
InputQueue iqueue; \
|
||
|
|
/* Output queue.*/ \
|
||
|
|
OutputQueue oqueue; \
|
||
|
|
/* Input buffer.*/ \
|
||
|
|
uint8_t ib[SERIAL_USB_BUFFERS_SIZE]; \
|
||
|
|
/* Output buffer.*/ \
|
||
|
|
uint8_t ob[SERIAL_USB_BUFFERS_SIZE]; \
|
||
|
|
/* End of the mandatory fields.*/ \
|
||
|
|
/* Current configuration data.*/ \
|
||
|
|
const SerialUSBConfig *config;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief @p SerialUSBDriver specific methods.
|
||
|
|
*/
|
||
|
|
#define _serial_usb_driver_methods \
|
||
|
|
_base_asynchronous_channel_methods
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @extends BaseAsynchronousChannelVMT
|
||
|
|
*
|
||
|
|
* @brief @p SerialDriver virtual methods table.
|
||
|
|
*/
|
||
|
|
struct SerialUSBDriverVMT {
|
||
|
|
_serial_usb_driver_methods
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @extends BaseAsynchronousChannel
|
||
|
|
*
|
||
|
|
* @brief Full duplex serial driver class.
|
||
|
|
* @details This class extends @p BaseAsynchronousChannel by adding physical
|
||
|
|
* I/O queues.
|
||
|
|
*/
|
||
|
|
struct SerialUSBDriver {
|
||
|
|
/** @brief Virtual Methods Table.*/
|
||
|
|
const struct SerialUSBDriverVMT *vmt;
|
||
|
|
_serial_usb_driver_data
|
||
|
|
};
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Driver macros. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* External declarations. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
void sduInit(void);
|
||
|
|
void sduObjectInit(SerialUSBDriver *sdp);
|
||
|
|
void sduStart(SerialUSBDriver *sdup, const SerialUSBConfig *config);
|
||
|
|
void sduStop(SerialUSBDriver *sdup);
|
||
|
|
void sduConfigureHookI(SerialUSBDriver *sdup);
|
||
|
|
bool_t sduRequestsHook(USBDriver *usbp);
|
||
|
|
void sduDataTransmitted(USBDriver *usbp, usbep_t ep);
|
||
|
|
void sduDataReceived(USBDriver *usbp, usbep_t ep);
|
||
|
|
void sduInterruptTransmitted(USBDriver *usbp, usbep_t ep);
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* HAL_USE_SERIAL_USB */
|
||
|
|
|
||
|
|
#endif /* _SERIAL_USB_H_ */
|
||
|
|
|
||
|
|
/** @} */
|