mirror of
https://github.com/hathach/tinyusb.git
synced 2025-01-24 05:42:57 +08:00
107 lines
3.9 KiB
C
107 lines
3.9 KiB
C
/**************************************************************************/
|
|
/*!
|
|
@file usbd.h
|
|
@author hathach (tinyusb.org)
|
|
|
|
@section LICENSE
|
|
|
|
Software License Agreement (BSD License)
|
|
|
|
Copyright (c) 2013, hathach (tinyusb.org)
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
1. Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
2. Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
3. Neither the name of the copyright holders nor the
|
|
names of its contributors may be used to endorse or promote products
|
|
derived from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
|
|
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
|
|
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
This file is part of the tinyusb stack.
|
|
*/
|
|
/**************************************************************************/
|
|
|
|
/** \ingroup group_usbd
|
|
* @{ */
|
|
|
|
#ifndef _TUSB_USBD_H_
|
|
#define _TUSB_USBD_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
//--------------------------------------------------------------------+
|
|
// INCLUDE
|
|
//--------------------------------------------------------------------+
|
|
#include <common/tusb_common.h>
|
|
#include "osal/osal.h"
|
|
#include "device/dcd.h"
|
|
|
|
//--------------------------------------------------------------------+
|
|
// MACRO CONSTANT TYPEDEF
|
|
//--------------------------------------------------------------------+
|
|
|
|
/// \brief Descriptor pointer collector to all the needed.
|
|
typedef struct {
|
|
void const * device; ///< pointer to device descriptor \ref tusb_desc_device_t
|
|
void const * config; ///< pointer to the whole configuration descriptor, starting by \ref tusb_desc_configuration_t
|
|
|
|
uint8_t const** string_arr; ///< a array of pointers to string descriptors
|
|
uint16_t string_count;
|
|
|
|
struct {
|
|
uint8_t const* generic;
|
|
uint8_t const* boot_keyboard;
|
|
uint8_t const* boot_mouse;
|
|
} hid_report;
|
|
|
|
}tud_desc_set_t;
|
|
|
|
|
|
// Must be defined by application
|
|
extern tud_desc_set_t tud_desc_set;
|
|
|
|
//--------------------------------------------------------------------+
|
|
// APPLICATION API
|
|
//--------------------------------------------------------------------+
|
|
bool tud_mounted(void);
|
|
|
|
//--------------------------------------------------------------------+
|
|
// APPLICATION CALLBACK
|
|
//--------------------------------------------------------------------+
|
|
/** \brief Callback function that will be invoked device is mounted (configured) by USB host
|
|
* \note This callback should be used by Application to \b set-up application data
|
|
*/
|
|
void tud_mount_cb(void);
|
|
|
|
/** \brief Callback function that will be invoked when device is unmounted (bus reset/unplugged)
|
|
* \note This callback should be used by Application to \b tear-down application data
|
|
*/
|
|
void tud_umount_cb(void);
|
|
|
|
//void tud_device_suspended_cb(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _TUSB_USBD_H_ */
|
|
|
|
/** @} */
|