113e5c22e6
Current way of having a globally, but weakly defined static buffer has several shortcomings: - It forces user to have a certain "magic" byte array variable if they want to have a control buffer of different size. - Having a globally defined static array and a separate function to tell USB core about its size is error prone. - Its inner workings are not easily understandable form cursory look at API and one needs to go and look at the implementation code to connect all the pieces into a solid picture of how it works This commit adds two parameters to 'usbd_init' call that allow user to specify the pointer to the area of memory and a size of that memory which would be used by the USB core to store the data received during DATA stage of control requests. This approach, while further complicating the prototype of 'usbd_init', provides user with more flexibility allowing for any custom area of memory of any size to be used as control buffer. It also forces user to provide both address and memory size at the same time thus avoiding the possibility of user redefining 'usbd_control_buffer', but not calling 'usbd_set_control_buffer_size' after that.
117 lines
3.5 KiB
C
117 lines
3.5 KiB
C
/** @defgroup usb_driver_defines USB Drivers
|
|
|
|
@brief <b>Defined Constants and Types for the USB Drivers</b>
|
|
|
|
@ingroup USB_defines
|
|
|
|
@version 1.0.0
|
|
|
|
@author @htmlonly © @endhtmlonly 2010 Gareth McMullin <gareth@blacksphere.co.nz>
|
|
|
|
@date 10 March 2013
|
|
|
|
LGPL License Terms @ref lgpl_license
|
|
*/
|
|
|
|
/*
|
|
* This file is part of the libopencm3 project.
|
|
*
|
|
* Copyright (C) 2010 Gareth McMullin <gareth@blacksphere.co.nz>
|
|
*
|
|
* This library 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 __USBD_H
|
|
#define __USBD_H
|
|
|
|
#include <libopencm3/usb/usbstd.h>
|
|
|
|
BEGIN_DECLS
|
|
|
|
|
|
enum usbd_request_return_codes {
|
|
USBD_REQ_NOTSUPP = 0,
|
|
USBD_REQ_HANDLED = 1,
|
|
USBD_REQ_NEXT_CALLBACK = 2,
|
|
};
|
|
|
|
typedef struct _usbd_driver usbd_driver;
|
|
typedef struct _usbd_device usbd_device;
|
|
|
|
extern const usbd_driver stm32f103_usb_driver;
|
|
extern const usbd_driver stm32f107_usb_driver;
|
|
extern const usbd_driver stm32f207_usb_driver;
|
|
#define otgfs_usb_driver stm32f107_usb_driver
|
|
#define otghs_usb_driver stm32f207_usb_driver
|
|
|
|
/* <usb.c> */
|
|
extern usbd_device *usbd_init(const usbd_driver *driver,
|
|
const struct usb_device_descriptor *dev,
|
|
const struct usb_config_descriptor *conf,
|
|
const char **strings, int num_strings,
|
|
u8 *control_buffer, u16 control_buffer_size);
|
|
|
|
extern void usbd_register_reset_callback(usbd_device *usbd_dev,
|
|
void (*callback)(void));
|
|
extern void usbd_register_suspend_callback(usbd_device *usbd_dev,
|
|
void (*callback)(void));
|
|
extern void usbd_register_resume_callback(usbd_device *usbd_dev,
|
|
void (*callback)(void));
|
|
extern void usbd_register_sof_callback(usbd_device *usbd_dev,
|
|
void (*callback)(void));
|
|
|
|
typedef int (*usbd_control_callback)(usbd_device *usbd_dev,
|
|
struct usb_setup_data *req, u8 **buf, u16 *len,
|
|
void (**complete)(usbd_device *usbd_dev,
|
|
struct usb_setup_data *req));
|
|
|
|
/* <usb_control.c> */
|
|
extern int usbd_register_control_callback(usbd_device *usbd_dev, u8 type,
|
|
u8 type_mask,
|
|
usbd_control_callback callback);
|
|
|
|
/* <usb_standard.c> */
|
|
extern void usbd_register_set_config_callback(usbd_device *usbd_dev,
|
|
void (*callback)(usbd_device *usbd_dev, u16 wValue));
|
|
|
|
/* Functions to be provided by the hardware abstraction layer */
|
|
extern void usbd_poll(usbd_device *usbd_dev);
|
|
extern void usbd_disconnect(usbd_device *usbd_dev, bool disconnected);
|
|
|
|
extern void usbd_ep_setup(usbd_device *usbd_dev, u8 addr, u8 type, u16 max_size,
|
|
void (*callback)(usbd_device *usbd_dev, u8 ep));
|
|
|
|
extern u16 usbd_ep_write_packet(usbd_device *usbd_dev, u8 addr,
|
|
const void *buf, u16 len);
|
|
|
|
extern u16 usbd_ep_read_packet(usbd_device *usbd_dev, u8 addr,
|
|
void *buf, u16 len);
|
|
|
|
extern void usbd_ep_stall_set(usbd_device *usbd_dev, u8 addr, u8 stall);
|
|
extern u8 usbd_ep_stall_get(usbd_device *usbd_dev, u8 addr);
|
|
|
|
extern void usbd_ep_nak_set(usbd_device *usbd_dev, u8 addr, u8 nak);
|
|
|
|
/* Optional */
|
|
extern void usbd_cable_connect(usbd_device *usbd_dev, u8 on);
|
|
|
|
END_DECLS
|
|
|
|
#endif
|
|
|
|
/**@}*/
|
|
|