forked from mfulz_github/qmk_firmware
131 lines
4.4 KiB
C
131 lines
4.4 KiB
C
/*
|
|
LUFA Library
|
|
Copyright (C) Dean Camera, 2013.
|
|
|
|
dean [at] fourwalledcubicle [dot] com
|
|
www.lufa-lib.org
|
|
*/
|
|
|
|
/*
|
|
Copyright 2013 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
|
|
|
Permission to use, copy, modify, distribute, and sell this
|
|
software and its documentation for any purpose is hereby granted
|
|
without fee, provided that the above copyright notice appear in
|
|
all copies and that both that the copyright notice and this
|
|
permission notice and warranty disclaimer appear in supporting
|
|
documentation, and that the name of the author not be used in
|
|
advertising or publicity pertaining to distribution of the
|
|
software without specific, written prior permission.
|
|
|
|
The author disclaims all warranties with regard to this
|
|
software, including all implied warranties of merchantability
|
|
and fitness. In no event shall the author be liable for any
|
|
special, indirect or consequential damages or any damages
|
|
whatsoever resulting from loss of use, data or profits, whether
|
|
in an action of contract, negligence or other tortious action,
|
|
arising out of or in connection with the use or performance of
|
|
this software.
|
|
*/
|
|
|
|
/** \file
|
|
* \brief USB Endpoint definitions for all architectures.
|
|
* \copydetails Group_EndpointManagement
|
|
*
|
|
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
|
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
|
*/
|
|
|
|
/** \ingroup Group_EndpointManagement
|
|
* \defgroup Group_EndpointRW Endpoint Data Reading and Writing
|
|
* \brief Endpoint data read/write definitions.
|
|
*
|
|
* Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
|
|
*/
|
|
|
|
/** \ingroup Group_EndpointRW
|
|
* \defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types
|
|
* \brief Endpoint data primitive read/write definitions.
|
|
*
|
|
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
|
|
* from and to endpoints.
|
|
*/
|
|
|
|
/** \ingroup Group_EndpointManagement
|
|
* \defgroup Group_EndpointPacketManagement Endpoint Packet Management
|
|
* \brief USB Endpoint package management definitions.
|
|
*
|
|
* Functions, macros, variables, enums and types related to packet management of endpoints.
|
|
*/
|
|
|
|
/** \ingroup Group_USB
|
|
* \defgroup Group_EndpointManagement Endpoint Management
|
|
* \brief Endpoint management definitions.
|
|
*
|
|
* Functions, macros and enums related to endpoint management when in USB Device mode. This
|
|
* module contains the endpoint management macros, as well as endpoint interrupt and data
|
|
* send/receive functions for various data types.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#ifndef __ENDPOINT_H__
|
|
#define __ENDPOINT_H__
|
|
|
|
/* Includes: */
|
|
#include "../../../Common/Common.h"
|
|
#include "USBMode.h"
|
|
|
|
/* Enable C linkage for C++ Compilers: */
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Preprocessor Checks: */
|
|
#if !defined(__INCLUDE_FROM_USB_DRIVER)
|
|
#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
|
|
#endif
|
|
|
|
/* Public Interface - May be used in end-application: */
|
|
/* Type Defines: */
|
|
/** Type define for a endpoint table entry, used to configure endpoints in groups via
|
|
* \ref Endpoint_ConfigureEndpointTable().
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t Address; /**< Address of the endpoint to configure, or zero if the table entry is to be unused. */
|
|
uint16_t Size; /**< Size of the endpoint bank, in bytes. */
|
|
uint8_t Type; /**< Type of the endpoint, a \c EP_TYPE_* mask. */
|
|
uint8_t Banks; /**< Number of hardware banks to use for the endpoint. */
|
|
} USB_Endpoint_Table_t;
|
|
|
|
/* Macros: */
|
|
/** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
|
|
* numerical address in the device.
|
|
*/
|
|
#define ENDPOINT_EPNUM_MASK 0x0F
|
|
|
|
/** Endpoint address for the default control endpoint, which always resides in address 0. This is
|
|
* defined for convenience to give more readable code when used with the endpoint macros.
|
|
*/
|
|
#define ENDPOINT_CONTROLEP 0
|
|
|
|
/* Architecture Includes: */
|
|
#if (ARCH == ARCH_AVR8)
|
|
#include "AVR8/Endpoint_AVR8.h"
|
|
#elif (ARCH == ARCH_UC3)
|
|
#include "UC3/Endpoint_UC3.h"
|
|
#elif (ARCH == ARCH_XMEGA)
|
|
#include "XMEGA/Endpoint_XMEGA.h"
|
|
#endif
|
|
|
|
/* Disable C linkage for C++ Compilers: */
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|
|
/** @} */
|
|
|