Add 'fw/' from commit '5b94dee9cf'

git-subtree-dir: fw
git-subtree-mainline: 6eddc61626
git-subtree-split: 5b94dee9cf
This commit is contained in:
jaseg 2021-03-02 19:27:52 +01:00
commit b328ef6059
63 changed files with 13005 additions and 0 deletions

27
fw/include/cobs.h Normal file
View file

@ -0,0 +1,27 @@
#ifndef __COBS_H__
#define __COBS_H__
#include <stdint.h>
#include <unistd.h>
#include <string.h>
struct cobs_decode_state {
size_t p;
size_t c;
};
ssize_t cobs_encode(char *dst, size_t dstlen, char *src, size_t srclen);
ssize_t cobs_decode(char *dst, size_t dstlen, char *src, size_t srclen);
int cobs_encode_incremental(void *f, int (*output)(void *f, unsigned char c), unsigned char *src, size_t srclen);
/*@ requires \valid(state);
ensures state->p == 0 && state->c == 0;
assigns *state;
@*/
void cobs_decode_incremental_initialize(struct cobs_decode_state *state);
int cobs_decode_incremental(struct cobs_decode_state *state, unsigned char *dst, size_t dstlen, unsigned char src);
#endif//__COBS_H__

View file

@ -0,0 +1,326 @@
/*
* This file is part of the libusbhost library
* hosted at http://github.com/libusbhost/libusbhost
*
* Copyright (C) 2015 Amir Hammad <amir.hammad@hotmail.com>
*
*
* libusbhost is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef USBH_DEVICE_DRIVER_
#define USBH_DEVICE_DRIVER_
#include "usbh_config.h"
#include "usbh_core.h"
#include <libopencm3/usb/usbstd.h>
#include <stdint.h>
BEGIN_DECLS
enum USBH_ENDPOINT_TYPE {
USBH_ENDPOINT_TYPE_CONTROL = 0,
USBH_ENDPOINT_TYPE_ISOCHRONOUS = 1,
USBH_ENDPOINT_TYPE_BULK = 2,
USBH_ENDPOINT_TYPE_INTERRUPT = 3,
};
enum USBH_SPEED {
USBH_SPEED_FULL = 0,
USBH_SPEED_LOW = 1,
USBH_SPEED_HIGH = 2,
};
enum USBH_PACKET_CALLBACK_STATUS {
USBH_PACKET_CALLBACK_STATUS_OK = 0,
USBH_PACKET_CALLBACK_STATUS_ERRSIZ = 1,
USBH_PACKET_CALLBACK_STATUS_EAGAIN = 2, // -- TODO: automatic handling of transmit errors 3xTXERR->FATAL
USBH_PACKET_CALLBACK_STATUS_EFATAL = 3
};
enum USBH_POLL_STATUS {
USBH_POLL_STATUS_NONE,
USBH_POLL_STATUS_DEVICE_CONNECTED,
USBH_POLL_STATUS_DEVICE_DISCONNECTED
};
enum USBH_CONTROL_TYPE {
USBH_CONTROL_TYPE_SETUP,
USBH_CONTROL_TYPE_DATA
};
enum USBH_ENUM_STATE {
USBH_ENUM_STATE_SET_ADDRESS,
USBH_ENUM_STATE_FIRST = USBH_ENUM_STATE_SET_ADDRESS,
USBH_ENUM_STATE_DEVICE_DT_READ_SETUP,
USBH_ENUM_STATE_DEVICE_DT_READ_COMPLETE,
USBH_ENUM_STATE_CONFIGURATION_DT_HEADER_READ_SETUP,
USBH_ENUM_STATE_CONFIGURATION_DT_HEADER_READ,
USBH_ENUM_STATE_CONFIGURATION_DT_HEADER_READ_COMPLETE,
USBH_ENUM_STATE_CONFIGURATION_DT_READ_SETUP,
USBH_ENUM_STATE_CONFIGURATION_DT_READ,
USBH_ENUM_STATE_CONFIGURATION_DT_READ_COMPLETE,
USBH_ENUM_STATE_SET_CONFIGURATION_SETUP,
USBH_ENUM_STATE_SET_CONFIGURATION_COMPLETE,
USBH_ENUM_STATE_FIND_DRIVER,
};
enum USBH_CONTROL_STATE {
USBH_CONTROL_STATE_NONE,
USBH_CONTROL_STATE_SETUP,
USBH_CONTROL_STATE_DATA,
USBH_CONTROL_STATE_STATUS,
};
typedef struct _usbh_device usbh_device_t;
struct _usbh_packet_callback_data {
/// status - it is used for reporting of the errors
enum USBH_PACKET_CALLBACK_STATUS status;
/// count of bytes that has been actually transferred
uint32_t transferred_length;
};
typedef struct _usbh_packet_callback_data usbh_packet_callback_data_t;
typedef void (*usbh_packet_callback_t)(usbh_device_t *dev, usbh_packet_callback_data_t status);
struct _usbh_control {
enum USBH_CONTROL_STATE state;
usbh_packet_callback_t callback;
union {
const void *out;
void *in;
} data;
uint16_t data_length;
struct usb_setup_data setup_data;
};
typedef struct _usbh_control usbh_control_t;
/**
* @brief The _usbh_device struct
*
* This represents exactly one connected device.
*/
struct _usbh_device {
/// max packet size for control endpoint(0)
uint16_t packet_size_max0;
/// Device's address
int8_t address;
/// @see USBH_SPEED
enum USBH_SPEED speed;
/// state used for enumeration purposes
enum USBH_ENUM_STATE state;
usbh_control_t control;
/// toggle bit
uint8_t toggle0;
/**
* @brief drv - device driver used for this connected device
*/
const usbh_dev_driver_t *drv;
/**
* @brief drvdata - device driver's private data
*/
void *drvdata;
/**
* @brief lld - pointer to a low-level driver's instance
*/
const void *lld;
};
typedef struct _usbh_device usbh_device_t;
struct _usbh_packet {
/// pointer to data
union {
const void *out;
void *in;
} data;
/// length of the data (up to 1023)
uint16_t datalen;
/// Device's address
int8_t address;
/**
* @brief Endpoint type
* @see USBH_ENDPOINT_TYPE
*/
enum USBH_ENDPOINT_TYPE endpoint_type;
enum USBH_CONTROL_TYPE control_type;
/// Endpoint number 0..15
uint8_t endpoint_address;
/// Max packet size for an endpoint
uint16_t endpoint_size_max;
/// @see USBH_SPEED
enum USBH_SPEED speed;
uint8_t *toggle;
/**
* @brief callback this will be called when the packet is finished - either successfuly or not.
*/
usbh_packet_callback_t callback;
/**
* @brief callback_arg argument passed into callback
*
* Low level driver is not allowed to alter the data pointed by callback_arg
*/
void *callback_arg;
};
typedef struct _usbh_packet usbh_packet_t;
struct _usbh_low_level_driver {
/**
* @brief init initialization routine of the low-level driver
*
*
* This function is called during the initialization of the library
*
* @see usbh_init()
*/
void (*init)(void *drvdata);
/**
* write - perform a write to a device
* @see usbh_packet_t
*/
void (*write)(void *drvdata, const usbh_packet_t *packet);
/**
* @brief read - perform a read from a device
* @see usbh_packet_t
*/
void (*read)(void *drvdata, usbh_packet_t *packet);
/**
* @brief this is called as a part of @ref usbh_poll() routine
*/
enum USBH_POLL_STATUS (*poll)(void *drvdata, uint32_t time_curr_us);
/**
* @brief speed of the low-level bus
*/
enum USBH_SPEED (*root_speed)(void *drvdata);
/**
* @brief Pointer to Low-level driver data
*
* Data pointed by this pointer should not be altered by the logic other from low-level driver's logic
*/
void *driver_data;
};
typedef struct _usbh_low_level_driver usbh_low_level_driver_t;
struct _usbh_generic_data {
usbh_device_t usbh_device[USBH_MAX_DEVICES];
uint8_t usbh_buffer[BUFFER_ONE_BYTES];
};
typedef struct _usbh_generic_data usbh_generic_data_t;
/// set to -1 for unused items ("don't care" functionality) @see find_driver()
struct _usbh_dev_driver_info {
int32_t deviceClass;
int32_t deviceSubClass;
int32_t deviceProtocol;
int32_t idVendor;
int32_t idProduct;
int32_t ifaceClass;
int32_t ifaceSubClass;
int32_t ifaceProtocol;
};
typedef struct _usbh_dev_driver_info usbh_dev_driver_info_t;
struct _usbh_dev_driver {
/**
* @brief init is initialization routine of the device driver
*
* This function is called during the initialization of the device driver
*/
void *(*init)(usbh_device_t *usbh_dev);
/**
* @brief analyze descriptor
* @param[in/out] drvdata is the device driver's private data
* @param[in] descriptor is the pointer to the descriptor that should
* be parsed in order to prepare driver to be loaded
*
* @retval true when the enumeration is complete and the driver is ready to be used
* @retval false when the device driver is not ready to be used
*
* This should be used for getting correct endpoint numbers, getting maximum sizes of endpoints.
* Should return true, when no more data is needed.
*
*/
bool (*analyze_descriptor)(void *drvdata, void *descriptor);
/**
* @brief poll method is called periodically by the library core
* @param[in/out] drvdata is the device driver's private data
* @param[in] time_curr_us current timestamp in microseconds
* @see usbh_poll()
*/
void (*poll)(void *drvdata, uint32_t time_curr_us);
/**
* @brief unloads the device driver
* @param[in/out] drvdata is the device driver's private data
*
* This should free any data associated with this device
*/
void (*remove)(void *drvdata);
/**
* @brief info - compatibility information about the driver. It is used by the core during device enumeration
* @see find_driver()
*/
const usbh_dev_driver_info_t * const info;
};
typedef struct _usbh_dev_driver usbh_dev_driver_t;
#define ERROR(arg) LOG_PRINTF("UNHANDLED_ERROR %d: file: %s, line: %d",\
arg, __FILE__, __LINE__)
/* Hub related functions */
usbh_device_t *usbh_get_free_device(const usbh_device_t *dev);
bool usbh_enum_available(void);
void device_enumeration_start(usbh_device_t *dev);
/* All devices functions */
void usbh_read(usbh_device_t *dev, usbh_packet_t *packet);
void usbh_write(usbh_device_t *dev, const usbh_packet_t *packet);
/* Helper functions used by device drivers */
void device_control(usbh_device_t *dev, usbh_packet_callback_t callback, const struct usb_setup_data *setup_data, void *data);
void device_remove(usbh_device_t *dev);
END_DECLS
#endif

62
fw/include/usbh_config.h Normal file
View file

@ -0,0 +1,62 @@
/*
* This file is part of the libusbhost library
* hosted at http://github.com/libusbhost/libusbhost
*
* Copyright (C) 2015 Amir Hammad <amir.hammad@hotmail.com>
*
*
* libusbhost is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef USBH_CONFIG_
#define USBH_CONFIG_
// Max devices per hub
#define USBH_HUB_MAX_DEVICES (8)
// Max number of hub instancies
#define USBH_MAX_HUBS (2)
// Max devices
#define USBH_MAX_DEVICES (15)
// Min: 128
// Set this wisely
#define BUFFER_ONE_BYTES (2048)
// HID class devices
#define USBH_HID_MAX_DEVICES (2)
#define USBH_HID_BUFFER (256)
#define USBH_HID_REPORT_BUFFER (4)
// MIDI
// Maximal number of midi devices connected to whatever hub
#define USBH_AC_MIDI_MAX_DEVICES (4)
#define USBH_AC_MIDI_BUFFER (64)
// Gamepad XBOX
#define USBH_GP_XBOX_MAX_DEVICES (2)
#define USBH_GP_XBOX_BUFFER (32)
/* Sanity checks */
#if (USBH_MAX_DEVICES > 127)
#error USBH_MAX_DEVICES > 127
#endif
#endif

65
fw/include/usbh_core.h Normal file
View file

@ -0,0 +1,65 @@
/*
* This file is part of the libusbhost library
* hosted at http://github.com/libusbhost/libusbhost
*
* Copyright (C) 2015 Amir Hammad <amir.hammad@hotmail.com>
*
*
* libusbhost is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef USBH_CORE_
#define USBH_CORE_
#include "usbh_config.h"
#include <stdint.h>
#include <stdbool.h>
/* This must be placed around external function declaration for C++
* support. */
#ifdef __cplusplus
# define BEGIN_DECLS extern "C" {
# define END_DECLS }
#else
# define BEGIN_DECLS
# define END_DECLS
#endif
BEGIN_DECLS
typedef struct _usbh_dev_driver usbh_dev_driver_t;
typedef struct _usbh_low_level_driver usbh_low_level_driver_t;
/**
* @brief usbh_init
* @param low_level_drivers list of the low level drivers to be used by this library
* @param device_drivers list of the device drivers that could be used with attached devices
*/
void usbh_init(const usbh_low_level_driver_t * const low_level_drivers[], const usbh_dev_driver_t * const device_drivers[]);
/**
* @brief usbh_poll
* @param time_curr_us - use monotically rising time
*
* time_curr_us:
* * can overflow, in time of this writing, after 1s
* * unit is microseconds
*/
void usbh_poll(uint32_t time_curr_us);
END_DECLS
#endif // USBH_CORE_

View file

@ -0,0 +1,65 @@
/*
* This file is part of the libusbhost library
* hosted at http://github.com/libusbhost/libusbhost
*
* Copyright (C) 2016 Amir Hammad <amir.hammad@hotmail.com>
*
*
* libusbhost is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef USBH_DRIVER_AC_MIDI_
#define USBH_DRIVER_AC_MIDI_
#include "usbh_core.h"
#include <stdint.h>
BEGIN_DECLS
struct _midi_config {
void (*read_callback)(int device_id, uint8_t *data);
void (*notify_connected)(int device_id);
void (*notify_disconnected)(int device_id);
};
typedef struct _midi_config midi_config_t;
/**
* @param bytes_written count of bytes that were actually written
*/
typedef void (*midi_write_callback_t)(uint8_t bytes_written);
/**
* @brief midi_driver_init initialization routine - this will initialize internal structures of this device driver
* @param config
*
* @see midi_config_t
*/
void midi_driver_init(const midi_config_t *config);
/**
* @brief usbh_midi_write
* @param device_id
* @param data
* @param length
* @param callback this is called when the write call finishes
*/
void usbh_midi_write(uint8_t device_id, const void *data, uint32_t length, midi_write_callback_t callback);
extern const usbh_dev_driver_t usbh_midi_driver;
END_DECLS
#endif

View file

@ -0,0 +1,78 @@
/*
* This file is part of the libusbhost library
* hosted at http://github.com/libusbhost/libusbhost
*
* Copyright (C) 2015 Amir Hammad <amir.hammad@hotmail.com>
*
*
* libusbhost is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef USBH_DRIVER_GP_XBOX_
#define USBH_DRIVER_GP_XBOX_
#include "usbh_core.h"
#include <stdint.h>
BEGIN_DECLS
#define GP_XBOX_DPAD_TOP (1 << 0)
#define GP_XBOX_DPAD_LEFT (1 << 1)
#define GP_XBOX_DPAD_BOTTOM (1 << 2)
#define GP_XBOX_DPAD_RIGHT (1 << 3)
#define GP_XBOX_BUTTON_X (1 << 4)
#define GP_XBOX_BUTTON_Y (1 << 5)
#define GP_XBOX_BUTTON_A (1 << 6)
#define GP_XBOX_BUTTON_B (1 << 7)
#define GP_XBOX_BUTTON_SELECT (1 << 8)
#define GP_XBOX_BUTTON_START (1 << 9)
#define GP_XBOX_BUTTON_LT (1 << 10)
#define GP_XBOX_BUTTON_RT (1 << 11)
#define GP_XBOX_BUTTON_XBOX (1 << 12)
#define GP_XBOX_BUTTON_AXIS_LEFT (1 << 13)
#define GP_XBOX_BUTTON_AXIS_RIGHT (1 << 14)
struct _gp_xbox_packet {
uint32_t buttons;
int16_t axis_left_x;
int16_t axis_left_y;
int16_t axis_right_x;
int16_t axis_right_y;
uint8_t axis_rear_left;
uint8_t axis_rear_right;
};
typedef struct _gp_xbox_packet gp_xbox_packet_t;
struct _gp_xbox_config {
void (*update)(uint8_t device_id, gp_xbox_packet_t data);
void (*notify_connected)(uint8_t device_id);
void (*notify_disconnected)(uint8_t device_id);
};
typedef struct _gp_xbox_config gp_xbox_config_t;
/**
* @brief gp_xbox_driver_init initialization routine - this will initialize internal structures of this device driver
* @see gp_xbox_config_t
*/
void gp_xbox_driver_init(const gp_xbox_config_t *config);
extern const usbh_dev_driver_t usbh_gp_xbox_driver;
END_DECLS
#endif

View file

@ -0,0 +1,85 @@
/*
* This file is part of the libusbhost library
* hosted at http://github.com/libusbhost/libusbhost
*
* Copyright (C) 2016 Amir Hammad <amir.hammad@hotmail.com>
*
*
* libusbhost is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef USBH_DRIVER_HID_
#define USBH_DRIVER_HID_
#include "usbh_core.h"
#include <stdint.h>
BEGIN_DECLS
struct _hid_mouse_config {
/**
* @brief this is called when some data is read when polling the device
* @param device_id handle of HID device
* @param data pointer to the data
* @param length count of bytes in the data
*
* TODO: make better interface that provides data contained in the report descriptor
*
*/
void (*hid_in_message_handler)(uint8_t device_id, const uint8_t *data, uint32_t length);
};
typedef struct _hid_mouse_config hid_config_t;
/**
* @brief hid_mouse_driver_init initialization routine - this will initialize internal structures of this device driver
* @param config
* @see hid_mouse_config_t
*/
void hid_driver_init(const hid_config_t *config);
/**
* @brief hid_set_report
* @param device_id handle of HID device
* @returns true on success, false otherwise
*/
bool hid_set_report(uint8_t device_id, uint8_t val);
enum HID_TYPE {
HID_TYPE_NONE,
HID_TYPE_MOUSE,
HID_TYPE_KEYBOARD,
};
/**
* @brief hid_get_type
* @param device_id handle of HID device
* @return type of attached HID
* @see enum HID_TYPE
*/
enum HID_TYPE hid_get_type(uint8_t device_id);
/**
* @brief hid_is_connected
* @param device_id handle of HID device
* @return true if the device with device_id is connected
*/
bool hid_is_connected(uint8_t device_id);
extern const usbh_dev_driver_t usbh_hid_driver;
END_DECLS
#endif

View file

@ -0,0 +1,39 @@
/*
* This file is part of the libusbhost library
* hosted at http://github.com/libusbhost/libusbhost
*
* Copyright (C) 2015 Amir Hammad <amir.hammad@hotmail.com>
*
*
* libusbhost is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef USBH_DRIVER_HUB_
#define USBH_DRIVER_HUB_
#include "usbh_core.h"
BEGIN_DECLS
/**
* @brief hub_driver_init initialization routine - this will initialize internal structures of this device driver
*/
void hub_driver_init(void);
extern const usbh_dev_driver_t usbh_hub_driver;
END_DECLS
#endif

View file

@ -0,0 +1,44 @@
/*
* This file is part of the libusbhost library
* hosted at http://github.com/libusbhost/libusbhost
*
* Copyright (C) 2015 Amir Hammad <amir.hammad@hotmail.com>
*
*
* libusbhost is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef USBH_LLD_STM32F4_H_
#define USBH_LLD_STM32F4_H_
#include "usbh_core.h"
#include <stdint.h>
BEGIN_DECLS
// pass this to usbh init
extern const usbh_low_level_driver_t usbh_lld_stm32f4_driver_fs;
extern const usbh_low_level_driver_t usbh_lld_stm32f4_driver_hs;
#ifdef USART_DEBUG
void print_channels(const void *drvdata);
#else
#define print_channels(arg) ((void)arg)
#endif
END_DECLS
#endif