LowLevel.h File Reference

#include <avr/io.h>
#include <avr/interrupt.h>
#include <stdbool.h>
#include "USBMode.h"
#include "../../../Common/Common.h"
#include "../HighLevel/Events.h"
#include "../HighLevel/USBTask.h"
#include "../HighLevel/USBInterrupt.h"
#include "Host.h"
#include "Pipe.h"
#include "OTG.h"
#include "Device.h"
#include "Endpoint.h"
#include "DevChapter9.h"

Defines

#define USB_MODE_NONE   0
#define USB_MODE_DEVICE   1
#define USB_MODE_HOST   2
#define USB_MODE_UID   3
#define USB_OPT_REG_DISABLED   (1 << 1)
#define USB_OPT_REG_ENABLED   (0 << 1)
#define EP_TYPE_CONTROL   0b00
#define EP_TYPE_ISOCHRONOUS   0b01
#define EP_TYPE_BULK   0b10
#define EP_TYPE_INTERRUPT   0b11
#define EP_TYPE_MASK   0b11
#define USB_VBUS_GetStatus()   ((USBSTA & (1 << VBUS)) ? true : false)
#define USB_Detach()   MACROS{ UDCON |= (1 << DETACH); }MACROE
#define USB_Attach()   MACROS{ UDCON &= ~(1 << DETACH); }MACROE

Enumerations

enum  USB_PowerOnErrorCodes_t { POWERON_ERROR_NoUSBModeSpecified = 0 }

Functions

void USB_Init (const uint8_t Mode, const uint8_t Options)
void USB_ShutDown (void)
 RAISES_EVENT (USB_Disconnect)
 RAISES_EVENT (USB_PowerOnFail)

Variables

volatile uint8_t USB_CurrentMode
volatile uint8_t USB_Options

Detailed Description

Main low level USB driver. This module manages the low level initialization and shut down of the USB AVR's USB interface in either device or (if supported) host mode.

Define Documentation

#define EP_TYPE_BULK   0b10

Mask for a BULK type endpoint or pipe.

Note:
See Endpoint.h and Pipe.h headers for endpoint/pipe functions.

#define EP_TYPE_CONTROL   0b00

Mask for a CONTROL type endpoint or pipe.

Note:
See Endpoint.h and Pipe.h headers for endpoint/pipe functions.

#define EP_TYPE_INTERRUPT   0b11

Mask for an INTERRUPT type endpoint or pipe.

Note:
See Endpoint.h and Pipe.h headers for endpoint/pipe functions.

#define EP_TYPE_ISOCHRONOUS   0b01

Mask for an ISOCHRONOUS type endpoint or pipe.

Note:
See Endpoint.h and Pipe.h headers for endpoint/pipe functions.

#define EP_TYPE_MASK   0b11

Mask for determining the type of an endpoint or pipe. This should then be compared with the EP_TYPE_* macros elsewhere in this module to determine the exact type of the endpoint or pipe.

Note:
See Endpoint.h and Pipe.h headers for endpoint/pipe functions.

 
#define USB_Attach (  )     MACROS{ UDCON &= ~(1 << DETACH); }MACROE

Attaches the device to the USB bus. This announces the device's presence to any attached USB host, starting the enumeration process. If no host is present, attaching the device will allow for enumeration once a host is connected to the device.

This is inexplicably also required for proper operation while in host mode, to enable the attachment of a device to the host. This is despite the bit being located in the device-mode register and despite the datasheet making no mention of its requirement in host mode.

 
#define USB_Detach (  )     MACROS{ UDCON |= (1 << DETACH); }MACROE

Detaches the device from the USB bus. This has the effect of removing the device from any host if, ceasing USB communications. If no host is present, this prevents any host from enumerating the device once attached until USB_Attach() is called.

#define USB_MODE_DEVICE   1

Mode mask for the USB_CurrentMode global and the USB_Init() function. This indicates that the USB interface is or should be initialized in the USB device mode.

#define USB_MODE_HOST   2

Mode mask for the USB_CurrentMode global and the USB_Init() function. This indicates that the USB interface is or should be initialized in the USB host mode.

Note:
Not all USB AVRs support host mode.

#define USB_MODE_NONE   0

Mode mask for the USB_CurrentMode global. This indicates that the USB interface is currently not initialized into any mode.

#define USB_MODE_UID   3

Mode mask for the the USB_Init() function. This indicates that the USB interface should be initialized into whatever mode the UID pin of the USB AVR indicates, and that the device should swap over its mode when the level of the UID pin changes during operation.

Note:
Not all USB AVRs support host mode, and thus UID mode.

#define USB_OPT_REG_DISABLED   (1 << 1)

Regulator disable mask for USB_Init(). This indicates that the internal 3.3V USB data pad regulator should be enabled to regulate the data pin voltages to within the USB standard.

Note:
See USB AVR data sheet for more information on the internal pad regulator.

#define USB_OPT_REG_ENABLED   (0 << 1)

Regulator enable mask for USB_Init(). This indicates that the internal 3.3V USB data pad regulator should be disabled and the AVR's VCC level used for the data pads.

Note:
See USB AVR data sheet for more information on the internal pad regulator.

 
#define USB_VBUS_GetStatus (  )     ((USBSTA & (1 << VBUS)) ? true : false)

Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power), otherwise returns false.


Enumeration Type Documentation

Enum for error codes relating to the powering on of the USB interface. These error codes are used in the ErrorCode parameter value of the USB_PowerOnFail event.

Enumerator:
POWERON_ERROR_NoUSBModeSpecified  Indicates that USB_Init() was called with an invalid or missing Mode parameter.


Function Documentation

RAISES_EVENT ( USB_PowerOnFail   ) 

This module raises the Power On Failure event when an error occurs while initializing the USB interface.

See also:
Events.h for more information on this event.

RAISES_EVENT ( USB_Disconnect   ) 

Indicates the current USB options that the USB interface was initialized with when USB_Init() was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module.

Note:
This variable should be treated as read-only in the user application, and never manually changed in value. This module raises the USB_Disconnect event if the USB interface is reset (such as during a mode change while in UID mode) while the USB interface is connected to a device when in host mode, or a host while in device mode.
See also:
Events.h for more information on this event.

void USB_Init ( const uint8_t  Mode,
const uint8_t  Options 
)

Main function to initialize and start the USB interface. Once active, the USB interface will allow for device connection to a host when in device mode, or for device enumeration while in host mode.

Parameters:
Mode This is a mask indicating what mode the USB interface is to be initialized to. Valid mode masks are USB_MODE_DEVICE, USB_MODE_HOST or USB_MODE_UID.
Options Mask indicating the options which should be used when initializing the USB interface to control the USB interface's behaviour. This should be comprised of a USB_OPT_REG_* mask to control the regulator, plus a USB_DEVICE_OPT_* mask when the device mode is enabled to set the device mode speed.
Note:
To reduce the FLASH requirements of the library if only device or host mode is required, this can be statically set via defining the token USB_DEVICE_ONLY for device mode or USB_HOST_ONLY for host mode in the use project makefile, passing the token to the compiler via the -D switch. If the mode is statically set, this parameter does not exist in the function prototype.

To reduce the FLASH requirements of the library if only fixed settings are are required, the options may be set statically in the same manner as the mode (see the Mode parameter of this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token, defined to the appropriate options masks. When the options are statically set, this parameter does not exist in the function prototype.

The mode parameter does not exist on devices where only one mode is possible, such as USB AVR models which only implement the USB device mode in hardware.

See also:
Device.h for the USB_DEVICE_OPT_* masks.

void USB_ShutDown ( void   ) 

Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface is restarted with the USB_Init() function.


Variable Documentation

volatile uint8_t USB_CurrentMode

Indicates the mode that the USB interface is currently initialized to. This value will be one of the USB_MODE_* masks defined elsewhere in this module.

Note:
This variable should be treated as read-only in the user application, and never manually changed in value.

volatile uint8_t USB_Options


Generated on Mon Jul 7 12:27:43 2008 for MyUSB Library by  doxygen 1.5.5