Transcript
Atmel Microcontrollers
AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) APPLICATION NOTE
Introduction USB Device Interface (UDI) for Human Interface Device Mouse (HID mouse) provides an interface for the configuration and management of USB HID mouse device. The outline of this documentation is as follows: • API Overview • Quick Start Guide for USB Device Mouse Module (UDI Mouse) • Configuration File Examples ®
For more details for Atmel Software Framework (ASF) USB Device Stack and USB Device HID Mouse, refer to following application notes: • AVR4900: ASF - USB Device Stack • AVR4903: ASF - USB Device HID Mouse Application • AVR4920: ASF - USB Device Stack - Compliance and Performance Figures • AVR4921: ASF - USB Device Stack Differences between ASF V1 and V2
Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
Table of Contents Introduction......................................................................................................................1 1. Software License....................................................................................................... 4 2. API Overview............................................................................................................. 5 2.1.
Variable and Type Definitions....................................................................................................... 5 2.1.1. Interface with USB Device Core (UDC)......................................................................... 5
2.2.
Structure Definitions..................................................................................................................... 5 2.2.1. Struct udi_hid_mouse_desc_t....................................................................................... 5 2.2.2. Struct udi_hid_mouse_report_desc_t............................................................................ 5 Macro Definitions..........................................................................................................................5 2.3.1. USB Interface Descriptors............................................................................................. 5 2.3.2. Interfaces for Buttons Events.........................................................................................6 Function Definitions......................................................................................................................6 2.4.1. Interfaces for Mouse Events.......................................................................................... 6 2.4.2. Interfaces for Buttons Events.........................................................................................7
2.3.
2.4.
3. Quick Start Guide for USB Device Mouse Module (UDI Mouse)...............................9 3.1. 3.2. 3.3.
3.4. 3.5.
3.6.
3.7.
3.8.
Basic Use Case............................................................................................................................9 Setup Steps..................................................................................................................................9 Usage Steps.................................................................................................................................9 3.3.1. Example Code............................................................................................................... 9 3.3.2. Workflow...................................................................................................................... 10 Advanced Use Cases.................................................................................................................10 HID Mouse in a Composite Device.............................................................................................10 3.5.1. Setup Steps..................................................................................................................11 3.5.2. Usage Steps.................................................................................................................11 Change USB Speed................................................................................................................... 12 3.6.1. Setup Steps................................................................................................................. 12 3.6.2. Usage Steps................................................................................................................ 12 Use USB Strings.........................................................................................................................13 3.7.1. Setup Steps................................................................................................................. 13 3.7.2. Usage Steps................................................................................................................ 13 Use USB Remote Wakeup Feature............................................................................................13 3.8.1. Setup Steps................................................................................................................. 13
3.8.2. Usage Steps................................................................................................................ 14 3.9. Bus Power Application Recommendations................................................................................ 14 3.9.1. Setup Steps................................................................................................................. 14 3.9.2. Usage Steps................................................................................................................ 15 3.10. USB Dynamic Serial Number..................................................................................................... 15 3.10.1. Setup Steps................................................................................................................. 15 3.10.2. Usage Steps................................................................................................................ 15
4. Configuration File Examples....................................................................................17 4.1.
conf_usb.h..................................................................................................................................17
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
2
4.1.1. 4.2.
4.3. 4.4.
UDI HID MOUSE Single.............................................................................................. 17
4.1.2. UDI HID MOUSE Multiple (Composite)....................................................................... 18 conf_clock.h................................................................................................................................23 4.2.1. AT32UC3A0, AT32UC3A1, AT32UC3B Devices (USBB)............................................ 23 4.2.2. AT32UC3A3 and AT32UC3A4 Devices (USBB with High Speed Support)................. 24 4.2.3. AT32UC3C, ATUCXXD, ATUCXXL3U, ATUCXXL4U Devices (USBC).......................24 4.2.4. SAM3X and SAM3A Devices (UOTGHS: USB OTG High Speed)..............................25 conf_clocks.h..............................................................................................................................26 4.3.1. SAM D21 Device (USB)...............................................................................................26 conf_board.h...............................................................................................................................29 4.4.1. AT32UC3A0, AT32UC3A1, AT32UC3B Devices (USBB)............................................ 29 4.4.2. AT32UC3A3 and AT32UC3A4 Devices (USBB with High Speed Support)................. 29 4.4.3. AT32UC3C, ATUCXXD, ATUCXXL3U, ATUCXXL4U Devices (USBC).......................30 4.4.4. SAM3X and SAM3A Devices (UOTGHS: USB OTG High Speed)..............................30 4.4.5. SAM D21 Device (USB)...............................................................................................30
5. USB Device Basic Setup......................................................................................... 31 5.1. 5.2. 5.3.
5.4.
Custom Configuration.................................................................................................................31 VBUS Monitoring........................................................................................................................32 USB Device Basic Setup............................................................................................................32 5.3.1. USB Device Controller (UDC) - Prerequisites............................................................. 32 5.3.2. USB Device Controller (UDC) - Example Code...........................................................33 5.3.3. USB Device Controller (UDC) - Workflow....................................................................34 conf_clock.h Examples...............................................................................................................34
6. Document Revision History..................................................................................... 36
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
3
1.
Software License 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. The name of Atmel may not be used to endorse or promote products derived from this software without specific prior written permission. 4. This software may only be redistributed and used in connection with an Atmel microcontroller product. THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL 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.
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
4
2.
API Overview
2.1.
Variable and Type Definitions
2.1.1.
Interface with USB Device Core (UDC) Structure required by UDC.
2.1.1.1.
Variable udi_api_hid_mouse UDC_DESC_STORAGE udi_api_t udi_api_hid_mouse
Global structure which contains standard UDI API for UDC.
2.2.
Structure Definitions
2.2.1.
Struct udi_hid_mouse_desc_t Interface descriptor structure for HID mouse. Table 2-1. Members
2.2.2.
Type
Name
Description
usb_ep_desc_t
ep
Standard USB endpoint descriptor structure
usb_hid_descriptor_t
hid
HID Descriptor
usb_iface_desc_t
iface
Standard USB interface descriptor structure
Struct udi_hid_mouse_report_desc_t Report descriptor for HID mouse. Table 2-2. Members
Type
Name
Description
uint8_t
array[]
Array to put detailed report data
2.3.
Macro Definitions
2.3.1.
USB Interface Descriptors The following structures provide predefined USB interface descriptors. It must be used to define the final USB descriptors.
2.3.1.1.
Macro UDI_HID_MOUSE_STRING_ID #define UDI_HID_MOUSE_STRING_ID
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
5
By default no string associated to this interface. 2.3.1.2.
Macro UDI_HID_MOUSE_EP_SIZE #define UDI_HID_MOUSE_EP_SIZE
HID mouse endpoints size. 2.3.1.3.
Macro UDI_HID_MOUSE_DESC #define UDI_HID_MOUSE_DESC
Content of HID mouse interface descriptor for all speed. 2.3.2.
Interfaces for Buttons Events
2.3.2.1.
Macro HID_MOUSE_BTN_DOWN #define HID_MOUSE_BTN_DOWN
Value to signal a button down (pressed). 2.3.2.2.
Macro HID_MOUSE_BTN_UP #define HID_MOUSE_BTN_UP
Value to signal a button up (released).
2.4.
Function Definitions
2.4.1.
Interfaces for Mouse Events
2.4.1.1.
Function udi_hid_mouse_moveScroll()
Move the scroll wheel. bool udi_hid_mouse_moveScroll( int8_t pos) Table 2-3. Parameters
Data direction
Parameter name
Description
[in]
pos
Signed value to move
Returns 1 if function was successfully done, otherwise 0. 2.4.1.2.
Function udi_hid_mouse_moveY()
Move the mouse pointer on Y axe. bool udi_hid_mouse_moveY( int8_t pos_y)
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
6
Table 2-4. Parameters
Data direction
Parameter name
Description
[in]
pos_y
Signed value to move
Returns 1 if function was successfully done, otherwise 0. 2.4.1.3.
Function udi_hid_mouse_moveX()
Move the mouse pointer on X axe. bool udi_hid_mouse_moveX( int8_t pos_x) Table 2-5. Parameters
Data direction
Parameter name
Description
[in]
pos_x
Signed value to move
Returns 1 if function was successfully done, otherwise 0. 2.4.2.
Interfaces for Buttons Events
2.4.2.1.
Function udi_hid_mouse_btnmiddle()
Changes middle button state. bool udi_hid_mouse_btnmiddle( bool b_state) Table 2-6. Parameters
Data direction
Parameter name
Description
[in]
b_state
New button state
Returns 1 if function was successfully done, otherwise 0. 2.4.2.2.
Function udi_hid_mouse_btnright()
Changes right button state. bool udi_hid_mouse_btnright( bool b_state) Table 2-7. Parameters
Data direction
Parameter name
Description
[in]
b_state
New button state
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
7
Returns 1 if function was successfully done, otherwise 0. 2.4.2.3.
Function udi_hid_mouse_btnleft()
Changes left button state. bool udi_hid_mouse_btnleft( bool b_state) Table 2-8. Parameters
Data direction
Parameter name
Description
[in]
b_state
New button state
Returns 1 if function was successfully done, otherwise 0.
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
8
3.
Quick Start Guide for USB Device Mouse Module (UDI Mouse) This is the quick start guide for the USB Device Mouse Module (UDI Mouse) with step-by-step instructions on how to configure and use the modules in a selection of use cases. The use cases contain several code fragments. The code fragments in the steps for setup can be copied into a custom initialization function, while the steps for usage can be copied into, e.g., the main application function.
3.1.
Basic Use Case In this basic use case, the "USB HID Mouse (Single Interface Device)" module is used. The "USB HID Mouse (Composite Device)" module usage is described in Advanced Use Cases.
3.2.
Setup Steps As a USB device, it follows common USB device setup steps. Refer to USB Device Basic Setup.
3.3.
Usage Steps
3.3.1.
Example Code Content of conf_usb.h: #define UDI_HID_MOUSE_ENABLE_EXT() my_callback_mouse_enable()
extern bool my_callback_mouse_enable(void);
#define UDI_HID_MOUSE_DISABLE_EXT() my_callback_mouse_disable() extern void my_callback_mouse_disable(void); #include "udi_hid_mouse_conf.h" // At the end of conf_usb.h file
Add to application C-file: static bool my_flag_autorize_mouse_events = false; bool my_callback_mouse_enable(void)
{
}
my_flag_autorize_mouse_events = true; return true;
void my_callback_mouse_disable(void)
{
}
my_flag_autorize_mouse_events = false;
void my_button_press_event(void)
{
}
if (!my_flag_autorize_mouse_events) { return;
} udi_hid_mouse_btnleft(HID_MOUSE_BTN_DOWN);
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
9
3.3.2.
Workflow 1.
Ensure that conf_usb.h is available and contains the following configuration which is the USB device mouse configuration: #define UDI_HID_MOUSE_ENABLE_EXT() my_callback_mouse_enable() extern bool my_callback_mouse_enable(void); Note: After the device enumeration (detecting and identifying USB devices), the USB host starts the device configuration. When the USB mouse interface from the device is accepted by the host, the USB host enables this interface and the UDI_HID_MOUSE_ENABLE_EXT() callback function is called and return true. Thus, it is recommended to enable sensors used by the mouse in this function. #define UDI_HID_MOUSE_DISABLE_EXT() my_callback_mouse_disable() extern void my_callback_mouse_disable(void);
2.
Note: When the USB device is unplugged or is reset by the USB host, the USB interface is disabled and the UDI_HID_MOUSE_DISABLE_EXT() callback function is called. Thus, it is recommended to disable sensors used by the mouse in this function. Send mouse events: // Sends a value at scroll wheel
udi_hid_mouse_moveScroll(int8_t pos); // Sends an Y axis value at mouse pointer
udi_hid_mouse_moveY(int8_t pos_y);
// Sends an X axis value at mouse pointer
udi_hid_mouse_moveX(int8_t pos_x);
// Sends a middle click event udi_hid_mouse_btnmiddle(bool b_state); // Sends a right click event udi_hid_mouse_btnright(bool b_state); // Sends a left click event udi_hid_mouse_btnleft(bool b_state);
3.4.
Advanced Use Cases For more advanced use of the UHI HID mouse module, see the following use cases: • HID Mouse in a Composite Device • Change USB Speed • Use USB Strings • Use USB Remote Wakeup Feature • •
3.5.
Bus Power Application Recommendations USB Dynamic Serial Number
HID Mouse in a Composite Device A USB Composite Device is a USB Device which uses more than one USB class. In this use case, the "USB HID Mouse (Composite Device)" module is used to create a USB composite device. Thus, this USB module can be associated with another "Composite Device" module, like "USB MSC (Composite Device)". Also, you can refer to application note AVR4902 ASF - USB Composite Device. Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
10
3.5.1.
Setup Steps For the setup code of this use case to work, the Basic Use Case must be followed.
3.5.2.
Usage Steps
3.5.2.1.
Example Code
Content of conf_usb.h: #define USB_DEVICE_EP_CTRL_SIZE 64 #define USB_DEVICE_NB_INTERFACE (X+1) #define USB_DEVICE_MAX_EP (X+1) #define UDI_HID_MOUSE_EP_IN (X | USB_EP_DIR_IN) #define UDI_HID_MOUSE_IFACE_NUMBER X #define UDI_COMPOSITE_DESC_T \ udi_hid_mouse_desc_t udi_hid_mouse; \ ... #define UDI_COMPOSITE_DESC_FS \ .udi_hid_mouse = UDI_HID_MOUSE_DESC, \ ... #define UDI_COMPOSITE_DESC_HS \ .udi_hid_mouse = UDI_HID_MOUSE_DESC, \ ... #define UDI_COMPOSITE_API \ &udi_api_hid_mouse, \ ... 3.5.2.2.
Workflow
1.
Ensure that conf_usb.h is available and contains the following parameters required for a USB composite device configuration: // // // //
Endpoint control size, This must be: - 8 for low speed - 8, 16, 32 or 64 for full speed device (8 is recommended to save RAM) - 64 for a high speed device
#define USB_DEVICE_EP_CTRL_SIZE
64
// Total Number of interfaces on this USB device. // Add 1 for HID mouse.
#define USB_DEVICE_NB_INTERFACE (X+1)
// Total number of endpoints on this USB device. // This must include each endpoint for each interface. // Add 1 for HID mouse.
#define USB_DEVICE_MAX_EP (X+1) 2.
Ensure that conf_usb.h contains the description of composite device: // The endpoint number chosen by you for the mouse. // The endpoint number starting from 1.
#define UDI_HID_MOUSE_EP_IN
(X | USB_EP_DIR_IN)
// The interface index of an interface starting from 0
#define UDI_HID_MOUSE_IFACE_NUMBER 3.
X
Ensure that conf_usb.h contains the following parameters required for a USB composite device configuration: // USB Interfaces descriptor structure
#define UDI_COMPOSITE_DESC_T \ ... udi_hid_mouse_desc_t udi_hid_mouse; \ Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
11
... // USB Interfaces descriptor value for Full Speed
#define UDI_COMPOSITE_DESC_FS \ ... .udi_hid_mouse = UDI_HID_MOUSE_DESC, \ ...
// USB Interfaces descriptor value for High Speed
#define UDI_COMPOSITE_DESC_HS \ ... .udi_hid_mouse = UDI_HID_MOUSE_DESC, \ ... // USB Interface APIs
#define UDI_COMPOSITE_API \ ... &udi_api_hid_mouse, \ ... Note: The descriptors order given in the four lists above must be the same as the order defined by all interface indexes. The interface index orders are defined through UDI_X_IFACE_NUMBER defines.
3.6.
Change USB Speed In this use case, the USB device is used with different USB speeds.
3.6.1.
Setup Steps Prior to implement this use case, be sure to have already applied the UDI module "basic use case".
3.6.2.
Usage Steps
3.6.2.1.
Example Code
Content of conf_usb.h: #if // Low speed #define USB_DEVICE_LOW_SPEED // #define USB_DEVICE_HS_SUPPORT
#elif // Full speed // #define USB_DEVICE_LOW_SPEED // #define USB_DEVICE_HS_SUPPORT
#elif // High speed
// #define USB_DEVICE_LOW_SPEED
#define USB_DEVICE_HS_SUPPORT #endif 3.6.2.2.
Workflow
1.
Ensure that conf_usb.h is available and contains the following parameters required for a USB device low speed (1.5Mbit/s): #define USB_DEVICE_LOW_SPEED //#define USB_DEVICE_HS_SUPPORT
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
12
2.
Ensure that conf_usb.h contains the following parameters required for a USB device full speed (12Mbit/s): //#define USB_DEVICE_LOW_SPEED //#define USB_DEVICE_HS_SUPPORT
3.
Ensure that conf_usb.h contains the following parameters required for a USB device high speed (480Mbit/s): //#define USB_DEVICE_LOW_SPEED
#define
3.7.
USB_DEVICE_HS_SUPPORT
Use USB Strings In this use case, the usual USB strings are added in the USB device.
3.7.1.
Setup Steps Prior to implement this use case, be sure to have already applied the UDI module "basic use case".
3.7.2.
Usage Steps
3.7.2.1.
Example Code
Content of conf_usb.h: #define #define #define 3.7.2.2.
USB_DEVICE_MANUFACTURE_NAME USB_DEVICE_PRODUCT_NAME USB_DEVICE_SERIAL_NAME
"Manufacture name" "Product name" "12...EF"
Workflow
1.
Ensure that conf_usb.h is available and contains the following parameters required to enable different USB strings: // Static ASCII name for the manufacture
#define
USB_DEVICE_MANUFACTURE_NAME "Manufacture name"
// Static ASCII name for the product
#define
USB_DEVICE_PRODUCT_NAME "Product name"
// Static ASCII name to enable and set a serial number
#define
3.8.
USB_DEVICE_SERIAL_NAME "12...EF"
Use USB Remote Wakeup Feature In this use case, the USB remote wakeup feature is enabled.
3.8.1.
Setup Steps Prior to implement this use case, be sure to have already applied the UDI module "basic use case".
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
13
3.8.2.
Usage Steps
3.8.2.1.
Example Code
Content of conf_usb.h: #define USB_DEVICE_ATTR \ (USB_CONFIG_ATTR_REMOTE_WAKEUP | USB_CONFIG_ATTR_..._POWERED) #define UDC_REMOTEWAKEUP_ENABLE() my_callback_remotewakeup_enable() extern void my_callback_remotewakeup_enable(void); #define UDC_REMOTEWAKEUP_DISABLE() my_callback_remotewakeup_disable() extern void my_callback_remotewakeup_disable(void); Add to application C-file: void my_callback_remotewakeup_enable(void)
{
// Enable application wakeup events (e.g. enable GPIO interrupt)
}
void my_callback_remotewakeup_disable(void)
{
// Disable application wakeup events (e.g. disable GPIO interrupt)
}
void my_interrupt_event(void)
{ } 3.8.2.2.
udc_remotewakeup();
Workflow
1.
Ensure that conf_usb.h is available and contains the following parameters required to enable the remote wakeup feature: // Authorizes the remote wakeup feature
#define USB_DEVICE_ATTR (USB_CONFIG_ATTR_REMOTE_WAKEUP | USB_CONFIG_ATTR_..._POWERED) // Define callback called when the host enables the remotewakeup feature
#define UDC_REMOTEWAKEUP_ENABLE() my_callback_remotewakeup_enable() extern void my_callback_remotewakeup_enable(void); // Define callback called when the host disables the remotewakeup feature
#define UDC_REMOTEWAKEUP_DISABLE() my_callback_remotewakeup_disable() extern void my_callback_remotewakeup_disable(void);
2.
Send a remote wakeup (USB upstream): udc_remotewakeup();
3.9.
Bus Power Application Recommendations In this use case, the USB device bus power feature is enabled. This feature requires a correct power consumption management.
3.9.1.
Setup Steps Prior to implement this use case, be sure to have already applied the UDI module "basic use case". Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
14
3.9.2.
Usage Steps
3.9.2.1.
Example Code
Content of conf_usb.h: #define #define
USB_DEVICE_ATTR (USB_CONFIG_ATTR_BUS_POWERED) UDC_SUSPEND_EVENT() user_callback_suspend_action() extern void user_callback_suspend_action(void) #define UDC_RESUME_EVENT() user_callback_resume_action() extern void user_callback_resume_action(void) Add to application C-file: void user_callback_suspend_action(void)
{ }
// Disable hardware component to reduce power consumption
void user_callback_resume_action(void)
{ } 3.9.2.2.
// Re-enable hardware component
Workflow
1.
Ensure that conf_usb.h is available and contains the following parameters: // Authorizes the BUS power feature
#define
USB_DEVICE_ATTR (USB_CONFIG_ATTR_BUS_POWERED)
// Define callback called when the host suspend the USB line
#define UDC_SUSPEND_EVENT() user_callback_suspend_action() extern void user_callback_suspend_action(void); // Define callback called when the host or device resume the USB line
#define UDC_RESUME_EVENT() user_callback_resume_action() extern void user_callback_resume_action(void); 2.
Reduce power consumption in suspend mode (max. 2.5mA on VBUS): void user_callback_suspend_action(void)
{ }
3.10.
turn_off_components();
USB Dynamic Serial Number In this use case, the USB serial strings are dynamic. For a static serial string refer to Use USB Strings.
3.10.1.
Setup Steps Prior to implement this use case, be sure to have already applied the UDI module "basic use case".
3.10.2.
Usage Steps
3.10.2.1. Example Code
Content of conf_usb.h: #define #define
USB_DEVICE_SERIAL_NAME USB_DEVICE_GET_SERIAL_NAME_POINTER serial_number Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
15
#define USB_DEVICE_GET_SERIAL_NAME_LENGTH extern uint8_t serial_number[];
12
Add to application C-file: uint8_t serial_number[USB_DEVICE_GET_SERIAL_NAME_LENGTH]; void init_build_usb_serial_number(void) { serial_number[0] = 'A'; serial_number[1] = 'B'; ... serial_number[USB_DEVICE_GET_SERIAL_NAME_LENGTH-1] = 'C'; } 3.10.2.2. Workflow
1.
Ensure that conf_usb.h is available and contains the following parameters required to enable a USB serial number string dynamically: #define USB_DEVICE_SERIAL_NAME // Define this empty #define USB_DEVICE_GET_SERIAL_NAME_POINTER serial_number // Give serial array pointer #define USB_DEVICE_GET_SERIAL_NAME_LENGTH 12 // Give size of serial array extern uint8_t serial_number[]; // Declare external serial array
2.
Before starting USB stack, initialize the serial array: uint8_t serial_number[USB_DEVICE_GET_SERIAL_NAME_LENGTH]; void init_build_usb_serial_number(void) { serial_number[0] = 'A'; serial_number[1] = 'B'; ... serial_number[USB_DEVICE_GET_SERIAL_NAME_LENGTH-1] = 'C'; }
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
16
4.
Configuration File Examples
4.1.
conf_usb.h
4.1.1.
UDI HID MOUSE Single /* * Support and FAQ: visit
Atmel Support */
#ifndef _CONF_USB_H_ #define _CONF_USB_H_ #include "compiler.h" #warning You must refill the following definitions with a correct values #define USB_DEVICE_VENDOR_ID #define USB_DEVICE_PRODUCT_ID #define USB_DEVICE_MAJOR_VERSION #define USB_DEVICE_MINOR_VERSION #define USB_DEVICE_POWER (mA) #define USB_DEVICE_ATTR (USB_CONFIG_ATTR_SELF_POWERED)
USB_VID_ATMEL USB_PID_ATMEL_ASF_HIDMOUSE 1 0 100 // Consumption on Vbus line \
// (USB_CONFIG_ATTR_BUS_POWERED) // (USB_CONFIG_ATTR_REMOTE_WAKEUP|USB_CONFIG_ATTR_SELF_POWERED) // (USB_CONFIG_ATTR_REMOTE_WAKEUP|USB_CONFIG_ATTR_BUS_POWERED) // #define // #define // #define //#define
USB_DEVICE_MANUFACTURE_NAME USB_DEVICE_PRODUCT_NAME USB_DEVICE_SERIAL_NAME
"Manufacture name" "Product name" "12...EF"
USB_DEVICE_LOW_SPEED
#if (UC3A3||UC3A4) //#define
#endif // // // // // // // // // // // // //
USB_DEVICE_HS_SUPPORT
#define UDC_VBUS_EVENT(b_vbus_high) user_callback_vbus_action(b_vbus_high) extern void user_callback_vbus_action(bool b_vbus_high); #define UDC_SOF_EVENT() user_callback_sof_action() extern void user_callback_sof_action(void); #define UDC_SUSPEND_EVENT() user_callback_suspend_action() extern void user_callback_suspend_action(void); #define UDC_RESUME_EVENT() user_callback_resume_action() extern void user_callback_resume_action(void); #define UDC_REMOTEWAKEUP_ENABLE() user_callback_remotewakeup_enable() extern void user_callback_remotewakeup_enable(void); #define UDC_REMOTEWAKEUP_DISABLE() user_callback_remotewakeup_disable() extern void user_callback_remotewakeup_disable(void); #define UDC_GET_EXTRA_STRING()
#define #define
UDI_HID_MOUSE_ENABLE_EXT() UDI_HID_MOUSE_DISABLE_EXT()
true
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
17
// // // //
#define UDI_HID_MOUSE_ENABLE_EXT() my_callback_mouse_enable() extern bool my_callback_mouse_enable(void); #define UDI_HID_MOUSE_DISABLE_EXT() my_callback_mouse_disable() extern void my_callback_mouse_disable(void);
#include "udi_hid_mouse_conf.h" #endif // _CONF_USB_H_ 4.1.2.
UDI HID MOUSE Multiple (Composite) /* * Support and FAQ: visit
Atmel Support */
#ifndef _CONF_USB_H_ #define _CONF_USB_H_ #include "compiler.h" #warning You must refill the following definitions with a correct values #define #define #define #define #define (mA) #define
USB_DEVICE_VENDOR_ID USB_DEVICE_PRODUCT_ID USB_DEVICE_MAJOR_VERSION USB_DEVICE_MINOR_VERSION USB_DEVICE_POWER USB_DEVICE_ATTR (USB_CONFIG_ATTR_SELF_POWERED)
USB_VID_ATMEL 0xFFFF 1 0 100 // Consumption on VBUS line \
// (USB_CONFIG_ATTR_BUS_POWERED) // (USB_CONFIG_ATTR_REMOTE_WAKEUP|USB_CONFIG_ATTR_SELF_POWERED) // (USB_CONFIG_ATTR_REMOTE_WAKEUP|USB_CONFIG_ATTR_BUS_POWERED) // #define // #define // #define //#define
USB_DEVICE_MANUFACTURE_NAME USB_DEVICE_PRODUCT_NAME USB_DEVICE_SERIAL_NAME
"Manufacture name" "Product name" "12...EF" // Disk SN for MSC
USB_DEVICE_LOW_SPEED
#if (UC3A3||UC3A4) //#define
#endif // // // // // // // // // // // // //
USB_DEVICE_HS_SUPPORT
#define UDC_VBUS_EVENT(b_vbus_high) user_callback_vbus_action(b_vbus_high) extern void user_callback_vbus_action(bool b_vbus_high); #define UDC_SOF_EVENT() user_callback_sof_action() extern void user_callback_sof_action(void); #define UDC_SUSPEND_EVENT() user_callback_suspend_action() extern void user_callback_suspend_action(void); #define UDC_RESUME_EVENT() user_callback_resume_action() extern void user_callback_resume_action(void); #define UDC_REMOTEWAKEUP_ENABLE() user_callback_remotewakeup_enable() extern void user_callback_remotewakeup_enable(void); #define UDC_REMOTEWAKEUP_DISABLE() user_callback_remotewakeup_disable() extern void user_callback_remotewakeup_disable(void); #define UDC_GET_EXTRA_STRING() Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
18
#define
USB_DEVICE_EP_CTRL_SIZE
64
#define
USB_DEVICE_NB_INTERFACE
1 // 1 or more
#define USB_DEVICE_MAX_EP interfaces
1 // 0 to max endpoint requested by
#define
UDI_CDC_PORT_NB 1
#define #define #define #define #define #define #define
UDI_CDC_ENABLE_EXT(port) UDI_CDC_DISABLE_EXT(port) UDI_CDC_RX_NOTIFY(port) UDI_CDC_TX_EMPTY_NOTIFY(port) UDI_CDC_SET_CODING_EXT(port,cfg) UDI_CDC_SET_DTR_EXT(port,set) UDI_CDC_SET_RTS_EXT(port,set)
true
/* * #define UDI_CDC_ENABLE_EXT(port) my_callback_cdc_enable() * extern bool my_callback_cdc_enable(void); * #define UDI_CDC_DISABLE_EXT(port) my_callback_cdc_disable() * extern void my_callback_cdc_disable(void); * #define UDI_CDC_RX_NOTIFY(port) my_callback_rx_notify(port) * extern void my_callback_rx_notify(uint8_t port); * #define UDI_CDC_TX_EMPTY_NOTIFY(port) my_callback_tx_empty_notify(port) * extern void my_callback_tx_empty_notify(uint8_t port); * #define UDI_CDC_SET_CODING_EXT(port,cfg) my_callback_config(port,cfg) * extern void my_callback_config(uint8_t port, usb_cdc_line_coding_t * cfg); * #define UDI_CDC_SET_DTR_EXT(port,set) my_callback_cdc_set_dtr(port,set) * extern void my_callback_cdc_set_dtr(uint8_t port, bool b_enable); * #define UDI_CDC_SET_RTS_EXT(port,set) my_callback_cdc_set_rts(port,set) * extern void my_callback_cdc_set_rts(uint8_t port, bool b_enable); */
#define
UDI_CDC_LOW_RATE
#define #define #define #define
UDI_CDC_DEFAULT_RATE UDI_CDC_DEFAULT_STOPBITS UDI_CDC_DEFAULT_PARITY UDI_CDC_DEFAULT_DATABITS
#define #define #define endpoint #define #define #define endpoint #define #define #define endpoint
UDI_CDC_DATA_EP_IN_0 UDI_CDC_DATA_EP_OUT_0 UDI_CDC_COMM_EP_0
(1 | USB_EP_DIR_IN) // TX (2 | USB_EP_DIR_OUT) // RX (3 | USB_EP_DIR_IN) // Notify
UDI_CDC_DATA_EP_IN_2 UDI_CDC_DATA_EP_OUT_2 UDI_CDC_COMM_EP_2
(4 | USB_EP_DIR_IN) // TX (5 | USB_EP_DIR_OUT) // RX (6 | USB_EP_DIR_IN) // Notify
UDI_CDC_DATA_EP_IN_3 UDI_CDC_DATA_EP_OUT_3 UDI_CDC_COMM_EP_3
(7 | USB_EP_DIR_IN) // TX (8 | USB_EP_DIR_OUT) // RX (9 | USB_EP_DIR_IN) // Notify
#define #define #define #define #define #define
UDI_CDC_COMM_IFACE_NUMBER_0 UDI_CDC_DATA_IFACE_NUMBER_0 UDI_CDC_COMM_IFACE_NUMBER_2 UDI_CDC_DATA_IFACE_NUMBER_2 UDI_CDC_COMM_IFACE_NUMBER_3 UDI_CDC_DATA_IFACE_NUMBER_3
0 1 2 3 4 5
115200 CDC_STOP_BITS_1 CDC_PAR_NONE 8
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
19
#define 'A', #define '1', #define #define #define
UDI_MSC_GLOBAL_VENDOR_ID 'T', 'M', 'E', 'L', ' ', ' ', ' ' UDI_MSC_GLOBAL_PRODUCT_VERSION '.', '0', '0' UDI_MSC_ENABLE_EXT() UDI_MSC_DISABLE_EXT() UDI_MSC_NOTIFY_TRANS_EXT()
\ \
true
/* * #define UDI_MSC_ENABLE_EXT() my_callback_msc_enable() * extern bool my_callback_msc_enable(void); * #define UDI_MSC_DISABLE_EXT() my_callback_msc_disable() * extern void my_callback_msc_disable(void); * #define UDI_MSC_NOTIFY_TRANS_EXT() msc_notify_trans() * extern void msc_notify_trans(void) { */
#define #define
UDI_MSC_EP_IN UDI_MSC_EP_OUT
(1 | USB_EP_DIR_IN) (2 | USB_EP_DIR_OUT)
#define
UDI_MSC_IFACE_NUMBER
0
#define #define
UDI_HID_MOUSE_ENABLE_EXT() UDI_HID_MOUSE_DISABLE_EXT()
// // // //
true
#define UDI_HID_MOUSE_ENABLE_EXT() my_callback_mouse_enable() extern bool my_callback_mouse_enable(void); #define UDI_HID_MOUSE_DISABLE_EXT() my_callback_mouse_disable() extern void my_callback_mouse_disable(void);
#define
UDI_HID_MOUSE_EP_IN
(1 | USB_EP_DIR_IN)
#define
UDI_HID_MOUSE_IFACE_NUMBER
0
#define #define
UDI_HID_KBD_ENABLE_EXT() UDI_HID_KBD_DISABLE_EXT()
// // // //
true
#define UDI_HID_KBD_ENABLE_EXT() my_callback_keyboard_enable() extern bool my_callback_keyboard_enable(void); #define UDI_HID_KBD_DISABLE_EXT() my_callback_keyboard_disable() extern void my_callback_keyboard_disable(void);
#define
UDI_HID_KBD_CHANGE_LED(value)
// #define UDI_HID_KBD_CHANGE_LED(value) my_callback_keyboard_led(value) // extern void my_callback_keyboard_led(uint8_t value)
#define
UDI_HID_KBD_EP_IN
(1 | USB_EP_DIR_IN)
#define
UDI_HID_KBD_IFACE_NUMBER
0
#define #define #define #define
UDI_HID_GENERIC_ENABLE_EXT() UDI_HID_GENERIC_DISABLE_EXT() UDI_HID_GENERIC_REPORT_OUT(ptr) UDI_HID_GENERIC_SET_FEATURE(f)
true
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
20
/* * #define UDI_HID_GENERIC_ENABLE_EXT() my_callback_generic_enable() * extern bool my_callback_generic_enable(void); * #define UDI_HID_GENERIC_DISABLE_EXT() my_callback_generic_disable() * extern void my_callback_generic_disable(void); * #define UDI_HID_GENERIC_REPORT_OUT(ptr) my_callback_generic_report_out(ptr) * extern void my_callback_generic_report_out(uint8_t *report); * #define UDI_HID_GENERIC_SET_FEATURE(f) my_callback_generic_set_feature(f) * extern void my_callback_generic_set_feature(uint8_t *report_feature); */
#define #define #define #define
UDI_HID_REPORT_IN_SIZE UDI_HID_REPORT_OUT_SIZE UDI_HID_REPORT_FEATURE_SIZE UDI_HID_GENERIC_EP_SIZE
#define #define
UDI_HID_GENERIC_EP_OUT UDI_HID_GENERIC_EP_IN
#define
UDI_HID_GENERIC_IFACE_NUMBER
#define #define
UDI_PHDC_ENABLE_EXT() UDI_PHDC_DISABLE_EXT()
#define #define
UDI_PHDC_DATAMSG_FORMAT UDI_PHDC_SPECIALIZATION
64 64 4 64
(2 | USB_EP_DIR_OUT) (1 | USB_EP_DIR_IN) 0
true USB_PHDC_DATAMSG_FORMAT_11073_20601 {0x2345} // Define in 11073_20601
#define
UDI_PHDC_QOS_OUT \ (USB_PHDC_QOS_MEDIUM_BETTER|USB_PHDC_QOS_HIGH_BEST) #define UDI_PHDC_QOS_IN \ (USB_PHDC_QOS_LOW_GOOD|USB_PHDC_QOS_MEDIUM_BETTER| USB_PHDC_QOS_MEDIUM_BEST) #define #define #define
UDI_PHDC_METADATA_DESC_BULK_IN UDI_PHDC_METADATA_DESC_BULK_OUT UDI_PHDC_METADATA_DESC_INT_IN
{0x01,0x02,0x03} {0x01,0x02,0x03} {0x01,0x02,0x03}
#define UDI_PHDC_EP_BULK_OUT (1 | USB_EP_DIR_OUT) #define UDI_PHDC_EP_BULK_IN (2 | USB_EP_DIR_IN) #if ((UDI_PHDC_QOS_IN&USB_PHDC_QOS_LOW_GOOD)==USB_PHDC_QOS_LOW_GOOD) // Only if UDI_PHDC_QOS_IN include USB_PHDC_QOS_LOW_GOOD
# define #endif
UDI_PHDC_EP_INTERRUPT_IN
(3 | USB_EP_DIR_IN)
#define #define #define
UDI_PHDC_EP_SIZE_BULK_OUT UDI_PHDC_EP_SIZE_BULK_IN UDI_PHDC_EP_SIZE_INT_IN
#define
UDI_PHDC_IFACE_NUMBER
#define #define #define #define
UDI_VENDOR_ENABLE_EXT() UDI_VENDOR_DISABLE_EXT() UDI_VENDOR_SETUP_OUT_RECEIVED() UDI_VENDOR_SETUP_IN_RECEIVED()
/* * * * *
32 32 8 0
true false false
#define UDI_VENDOR_ENABLE_EXT() my_callback_vendor_enable() extern bool my_callback_vendor_enable(void); #define UDI_VENDOR_DISABLE_EXT() my_callback_vendor_disable() extern void my_callback_vendor_disable(void); Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
21
* * #define UDI_VENDOR_SETUP_OUT_RECEIVED() my_vendor_setup_out_received() * extern bool my_vendor_setup_out_received(void); * #define UDI_VENDOR_SETUP_IN_RECEIVED() my_vendor_setup_in_received() * extern bool my_vendor_setup_in_received(void); */
#define #define #define
UDI_VENDOR_EPS_SIZE_INT_FS UDI_VENDOR_EPS_SIZE_BULK_FS UDI_VENDOR_EPS_SIZE_ISO_FS
64 64 256
#define #define #define
UDI_VENDOR_EPS_SIZE_INT_HS UDI_VENDOR_EPS_SIZE_BULK_HS UDI_VENDOR_EPS_SIZE_ISO_HS
64 512 64
#define #define #define #define #define #define
UDI_VENDOR_EP_INTERRUPT_IN UDI_VENDOR_EP_INTERRUPT_OUT UDI_VENDOR_EP_BULK_IN UDI_VENDOR_EP_BULK_OUT UDI_VENDOR_EP_ISO_IN UDI_VENDOR_EP_ISO_OUT
(1 (2 (3 (4 (5 (6
#define
UDI_VENDOR_IFACE_NUMBER
0
| | | | | |
USB_EP_DIR_IN) USB_EP_DIR_OUT) USB_EP_DIR_IN) USB_EP_DIR_OUT) USB_EP_DIR_IN) USB_EP_DIR_OUT)
//... Eventually add other Interface Configuration
#define UDI_COMPOSITE_DESC_T #define UDI_COMPOSITE_DESC_FS #define UDI_COMPOSITE_DESC_HS #define UDI_COMPOSITE_API /* Example for device with cdc, msc and hid mouse interface #define UDI_COMPOSITE_DESC_T \ usb_iad_desc_t udi_cdc_iad; \ udi_cdc_comm_desc_t udi_cdc_comm; \ udi_cdc_data_desc_t udi_cdc_data; \ udi_msc_desc_t udi_msc; \ udi_hid_mouse_desc_t udi_hid_mouse #define UDI_COMPOSITE_DESC_FS \ .udi_cdc_iad = UDI_CDC_IAD_DESC_0, \ .udi_cdc_comm = UDI_CDC_COMM_DESC_0, \ .udi_cdc_data = UDI_CDC_DATA_DESC_0_FS, \ .udi_msc = UDI_MSC_DESC_FS, \ .udi_hid_mouse = UDI_HID_MOUSE_DESC #define UDI_COMPOSITE_DESC_HS \ .udi_cdc_iad = UDI_CDC_IAD_DESC_0, \ .udi_cdc_comm = UDI_CDC_COMM_DESC_0, \ .udi_cdc_data = UDI_CDC_DATA_DESC_0_HS, \ .udi_msc = UDI_MSC_DESC_HS, \ .udi_hid_mouse = UDI_HID_MOUSE_DESC #define UDI_COMPOSITE_API &udi_api_cdc_comm, &udi_api_cdc_data, &udi_api_msc,
\
\ \ \
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
22
&udi_api_hid_mouse */
/* Example of include for interface #include "udi_msc.h" #include "udi_hid_kbd.h" #include "udi_hid_mouse.h" #include "udi_cdc.h" #include "udi_phdc.h" #include "udi_vendor.h" */ /* Declaration of callbacks used by USB #include "callback_def.h" */
#endif // _CONF_USB_H_
4.2.
conf_clock.h
4.2.1.
AT32UC3A0, AT32UC3A1, AT32UC3B Devices (USBB) /* * Support and FAQ: visit
Atmel Support */
#ifndef CONF_CLOCK_H_INCLUDED #define CONF_CLOCK_H_INCLUDED
// ===== System Clock Source Options //#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_RCSYS
//#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_PLL0
// ===== PLL0 Options //#define CONFIG_PLL0_SOURCE //#define CONFIG_PLL0_SOURCE //#define CONFIG_PLL0_MUL //#define CONFIG_PLL0_DIV
PLL_SRC_OSC0 PLL_SRC_OSC1 4 /* Fpll = (Fclk * PLL_mul) / PLL_div */ 1 /* Fpll = (Fclk * PLL_mul) / PLL_div */
#define CONFIG_SYSCLK_SOURCE
// ===== PLL1 Options
#define CONFIG_PLL1_SOURCE //#define CONFIG_PLL1_SOURCE
#define CONFIG_PLL1_MUL #define CONFIG_PLL1_DIV
SYSCLK_SRC_OSC0
PLL_SRC_OSC0 PLL_SRC_OSC1 8 /* Fpll = (Fclk * PLL_mul) / PLL_div */ 2 /* Fpll = (Fclk * PLL_mul) / PLL_div */
// ===== System Clock Bus Division Options //#define CONFIG_SYSCLK_CPU_DIV 0 /* Fcpu = Fsys/(2 ^ CPU_div) */ //#define CONFIG_SYSCLK_PBA_DIV 0 /* Fpba = Fsys/(2 ^ PBA_div) */ //#define CONFIG_SYSCLK_PBB_DIV 0 /* Fpbb = Fsys/(2 ^ PBB_div) */ // ===== Peripheral Clock Management Options //#define CONFIG_SYSCLK_INIT_CPUMASK ((1 << SYSCLK_SYSTIMER) | (1 << SYSCLK_OCD)) //#define CONFIG_SYSCLK_INIT_PBAMASK (1 << SYSCLK_USART0) //#define CONFIG_SYSCLK_INIT_PBBMASK (1 << SYSCLK_HMATRIX) //#define CONFIG_SYSCLK_INIT_HSBMASK (1 << SYSCLK_MDMA_HSB) // ===== USB Clock Source Options Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
23
//#define CONFIG_USBCLK_SOURCE //#define CONFIG_USBCLK_SOURCE
#define CONFIG_USBCLK_SOURCE #define CONFIG_USBCLK_DIV
USBCLK_SRC_OSC0 USBCLK_SRC_PLL0
USBCLK_SRC_PLL1 1 /* Fusb = Fsys/(2 ^ USB_div) */
#endif /* CONF_CLOCK_H_INCLUDED */ 4.2.2.
AT32UC3A3 and AT32UC3A4 Devices (USBB with High Speed Support) /* * Support and FAQ: visit
Atmel Support */
#ifndef CONF_CLOCK_H_INCLUDED #define CONF_CLOCK_H_INCLUDED
// ===== System Clock Source Options //#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_RCSYS
//#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_PLL0
// ===== PLL0 Options //#define CONFIG_PLL0_SOURCE //#define CONFIG_PLL0_SOURCE //#define CONFIG_PLL0_MUL //#define CONFIG_PLL0_DIV
PLL_SRC_OSC0 PLL_SRC_OSC1 11 /* Fpll = (Fclk * PLL_mul) / PLL_div */ 2 /* Fpll = (Fclk * PLL_mul) / PLL_div */
// ===== PLL1 Options //#define CONFIG_PLL1_SOURCE //#define CONFIG_PLL1_SOURCE //#define CONFIG_PLL1_MUL //#define CONFIG_PLL1_DIV
PLL_SRC_OSC0 PLL_SRC_OSC1 8 /* Fpll = (Fclk * PLL_mul) / PLL_div */ 2 /* Fpll = (Fclk * PLL_mul) / PLL_div */
#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_OSC0
// ===== System Clock Bus Division Options
#define CONFIG_SYSCLK_CPU_DIV #define CONFIG_SYSCLK_PBA_DIV //#define CONFIG_SYSCLK_PBB_DIV
0 /* Fcpu = Fsys/(2 ^ CPU_div) */ 0 /* Fpba = Fsys/(2 ^ PBA_div) */
0 /* Fpbb = Fsys/(2 ^ PBB_div) */
// ===== Peripheral Clock Management Options //#define CONFIG_SYSCLK_INIT_CPUMASK ((1 << SYSCLK_SYSTIMER) | (1 << SYSCLK_OCD)) //#define CONFIG_SYSCLK_INIT_PBAMASK (1 << SYSCLK_USART0) //#define CONFIG_SYSCLK_INIT_PBBMASK (1 << SYSCLK_HMATRIX) //#define CONFIG_SYSCLK_INIT_HSBMASK (1 << SYSCLK_MDMA_HSB) // ===== USB Clock Source Options
#define CONFIG_USBCLK_SOURCE //#define CONFIG_USBCLK_SOURCE //#define CONFIG_USBCLK_SOURCE
#define CONFIG_USBCLK_DIV
USBCLK_SRC_OSC0 USBCLK_SRC_PLL0 USBCLK_SRC_PLL1 1 /* Fusb = Fsys/(2 ^ USB_div) */
#endif /* CONF_CLOCK_H_INCLUDED */ 4.2.3.
AT32UC3C, ATUCXXD, ATUCXXL3U, ATUCXXL4U Devices (USBC) /* * Support and FAQ: visit
Atmel Support */
#ifndef CONF_CLOCK_H_INCLUDED #define CONF_CLOCK_H_INCLUDED
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
24
// ===== System Clock Source Options //#define CONFIG_SYSCLK_SOURCE //#define CONFIG_SYSCLK_SOURCE //#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_RCSYS SYSCLK_SRC_OSC0 SYSCLK_SRC_OSC1
//#define CONFIG_SYSCLK_SOURCE //#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_PLL1 SYSCLK_SRC_RC8M
#define CONFIG_SYSCLK_SOURCE
// ===== PLL0 Options
#define CONFIG_PLL0_SOURCE //#define CONFIG_PLL0_SOURCE //#define CONFIG_PLL0_SOURCE
SYSCLK_SRC_PLL0
PLL_SRC_OSC0
#define CONFIG_PLL0_MUL #define CONFIG_PLL0_DIV
PLL_SRC_OSC1 PLL_SRC_RC8M 3 /* Fpll = (Fclk * PLL_mul) / PLL_div */ 1 /* Fpll = (Fclk * PLL_mul) / PLL_div */
// ===== PLL1 Options //#define CONFIG_PLL1_SOURCE //#define CONFIG_PLL1_SOURCE //#define CONFIG_PLL1_SOURCE //#define CONFIG_PLL1_MUL //#define CONFIG_PLL1_DIV
PLL_SRC_OSC0 PLL_SRC_OSC1 PLL_SRC_RC8M 3 /* Fpll = (Fclk * PLL_mul) / PLL_div */ 1 /* Fpll = (Fclk * PLL_mul) / PLL_div */
// ===== System Clock Bus Division Options //#define CONFIG_SYSCLK_CPU_DIV 0 /* Fcpu = Fsys/(2 ^ //#define CONFIG_SYSCLK_PBA_DIV 0 /* Fpba = Fsys/(2 ^ //#define CONFIG_SYSCLK_PBB_DIV 0 /* Fpbb = Fsys/(2 ^ //#define CONFIG_SYSCLK_PBC_DIV 0 /* Fpbc = Fsys/(2 ^
CPU_div) PBA_div) PBB_div) PBC_div)
*/ */ */ */
// ===== Peripheral Clock Management Options //#define CONFIG_SYSCLK_INIT_CPUMASK ((1 << SYSCLK_SYSTIMER) | (1 << SYSCLK_OCD)) //#define CONFIG_SYSCLK_INIT_PBAMASK (1 << SYSCLK_USART0) //#define CONFIG_SYSCLK_INIT_PBBMASK (1 << SYSCLK_HMATRIX) //#define CONFIG_SYSCLK_INIT_HSBMASK (1 << SYSCLK_MDMA_HSB) // ===== USB Clock Source Options //#define CONFIG_USBCLK_SOURCE //#define CONFIG_USBCLK_SOURCE
#define CONFIG_USBCLK_SOURCE
//#define CONFIG_USBCLK_SOURCE
#define CONFIG_USBCLK_DIV
USBCLK_SRC_OSC0 USBCLK_SRC_OSC1
USBCLK_SRC_PLL0
USBCLK_SRC_PLL1 1 /* Fusb = Fsys/(2 ^ USB_div) */
#endif /* CONF_CLOCK_H_INCLUDED */ 4.2.4.
SAM3X and SAM3A Devices (UOTGHS: USB OTG High Speed) /* * Support and FAQ: visit
Atmel Support */
#ifndef CONF_CLOCK_H_INCLUDED #define CONF_CLOCK_H_INCLUDED // ===== System Clock (MCK) Source Options //#define CONFIG_SYSCLK_SOURCE SYSCLK_SRC_SLCK_RC //#define CONFIG_SYSCLK_SOURCE SYSCLK_SRC_SLCK_XTAL //#define CONFIG_SYSCLK_SOURCE SYSCLK_SRC_SLCK_BYPASS //#define CONFIG_SYSCLK_SOURCE SYSCLK_SRC_MAINCK_4M_RC //#define CONFIG_SYSCLK_SOURCE SYSCLK_SRC_MAINCK_8M_RC //#define CONFIG_SYSCLK_SOURCE SYSCLK_SRC_MAINCK_12M_RC //#define CONFIG_SYSCLK_SOURCE SYSCLK_SRC_MAINCK_XTAL //#define CONFIG_SYSCLK_SOURCE SYSCLK_SRC_MAINCK_BYPASS Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
25
#define CONFIG_SYSCLK_SOURCE //#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_PLLACK SYSCLK_SRC_UPLLCK
// ===== System Clock (MCK) Prescaler Options (Fmck = Fsys / (SYSCLK_PRES)) //#define CONFIG_SYSCLK_PRES SYSCLK_PRES_1
#define CONFIG_SYSCLK_PRES //#define //#define //#define //#define //#define //#define
CONFIG_SYSCLK_PRES CONFIG_SYSCLK_PRES CONFIG_SYSCLK_PRES CONFIG_SYSCLK_PRES CONFIG_SYSCLK_PRES CONFIG_SYSCLK_PRES
SYSCLK_PRES_2
SYSCLK_PRES_4 SYSCLK_PRES_8 SYSCLK_PRES_16 SYSCLK_PRES_32 SYSCLK_PRES_64 SYSCLK_PRES_3
// ===== PLL0 (A) Options (Fpll = (Fclk * PLL_mul) / PLL_div) // Use mul and div effective values here.
#define CONFIG_PLL0_SOURCE #define CONFIG_PLL0_MUL #define CONFIG_PLL0_DIV
PLL_SRC_MAINCK_XTAL 14 1
// ===== UPLL (UTMI) Hardware fixed at 480MHz. // ===== USB Clock Source Options // Use div effective value here. //#define CONFIG_USBCLK_SOURCE
#define CONFIG_USBCLK_SOURCE #define CONFIG_USBCLK_DIV // // // // // // // // // // // //
(Fusb = FpllX / USB_div) USBCLK_SRC_PLL0
USBCLK_SRC_UPLL 1
===== Target frequency (System clock) - XTAL frequency: 12MHz - System clock source: PLLA - System clock prescaler: 2 (divided by 2) - PLLA source: XTAL - PLLA output: XTAL * 14 / 1 - System clock is: 12 * 14 / 1 /2 = 84MHz ===== Target frequency (USB Clock) - USB clock source: UPLL - USB clock divider: 1 (not divided) - UPLL frequency: 480MHz - USB clock: 480 / 1 = 480MHz
#endif /* CONF_CLOCK_H_INCLUDED */
4.3.
conf_clocks.h
4.3.1.
SAM D21 Device (USB) /* * Support and FAQ: visit
Atmel Support */
#include
#ifndef CONF_CLOCKS_H_INCLUDED # define CONF_CLOCKS_H_INCLUDED /* System clock bus configuration */
# # #
define CONF_CLOCK_CPU_CLOCK_FAILURE_DETECT define CONF_CLOCK_FLASH_WAIT_STATES define CONF_CLOCK_CPU_DIVIDER
false 2 SYSTEM_MAIN_CLOCK_DIV_1
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
26
# # #
define CONF_CLOCK_APBA_DIVIDER define CONF_CLOCK_APBB_DIVIDER define CONF_CLOCK_APBC_DIVIDER
SYSTEM_MAIN_CLOCK_DIV_1 SYSTEM_MAIN_CLOCK_DIV_1 SYSTEM_MAIN_CLOCK_DIV_1
/* SYSTEM_CLOCK_SOURCE_OSC8M configuration - Internal 8MHz oscillator */
# # #
define CONF_CLOCK_OSC8M_PRESCALER define CONF_CLOCK_OSC8M_ON_DEMAND define CONF_CLOCK_OSC8M_RUN_IN_STANDBY
SYSTEM_OSC8M_DIV_1 true false
/* SYSTEM_CLOCK_SOURCE_XOSC configuration - External clock/oscillator */
# define CONF_CLOCK_XOSC_ENABLE # define CONF_CLOCK_XOSC_EXTERNAL_CRYSTAL SYSTEM_CLOCK_EXTERNAL_CRYSTAL # define CONF_CLOCK_XOSC_EXTERNAL_FREQUENCY # define CONF_CLOCK_XOSC_STARTUP_TIME # define CONF_CLOCK_XOSC_AUTO_GAIN_CONTROL # define CONF_CLOCK_XOSC_ON_DEMAND # define CONF_CLOCK_XOSC_RUN_IN_STANDBY
false
12000000UL SYSTEM_XOSC_STARTUP_32768 true true false
/* SYSTEM_CLOCK_SOURCE_XOSC32K configuration - External 32KHz crystal/clock oscillator */
# define CONF_CLOCK_XOSC32K_ENABLE false # define CONF_CLOCK_XOSC32K_EXTERNAL_CRYSTAL SYSTEM_CLOCK_EXTERNAL_CRYSTAL # define CONF_CLOCK_XOSC32K_STARTUP_TIME SYSTEM_XOSC32K_STARTUP_65536 # define CONF_CLOCK_XOSC32K_AUTO_AMPLITUDE_CONTROL false # define CONF_CLOCK_XOSC32K_ENABLE_1KHZ_OUPUT false # define CONF_CLOCK_XOSC32K_ENABLE_32KHZ_OUTPUT true # define CONF_CLOCK_XOSC32K_ON_DEMAND true # define CONF_CLOCK_XOSC32K_RUN_IN_STANDBY false
/* SYSTEM_CLOCK_SOURCE_OSC32K configuration - Internal 32KHz oscillator */
# # # # # #
define define define define define define
CONF_CLOCK_OSC32K_ENABLE CONF_CLOCK_OSC32K_STARTUP_TIME CONF_CLOCK_OSC32K_ENABLE_1KHZ_OUTPUT CONF_CLOCK_OSC32K_ENABLE_32KHZ_OUTPUT CONF_CLOCK_OSC32K_ON_DEMAND CONF_CLOCK_OSC32K_RUN_IN_STANDBY
false SYSTEM_OSC32K_STARTUP_130 true true true false
/* SYSTEM_CLOCK_SOURCE_DFLL configuration - Digital Frequency Locked Loop */
# define CONF_CLOCK_DFLL_ENABLE # define CONF_CLOCK_DFLL_LOOP_MODE SYSTEM_CLOCK_DFLL_LOOP_MODE_USB_RECOVERY # define CONF_CLOCK_DFLL_ON_DEMAND /* DFLL open loop mode configuration */
#
define CONF_CLOCK_DFLL_FINE_VALUE
/* DFLL closed loop mode configuration */
# # # # # # # #
define define define define define define define define
CONF_CLOCK_DFLL_SOURCE_GCLK_GENERATOR CONF_CLOCK_DFLL_MULTIPLY_FACTOR CONF_CLOCK_DFLL_QUICK_LOCK CONF_CLOCK_DFLL_TRACK_AFTER_FINE_LOCK CONF_CLOCK_DFLL_KEEP_LOCK_ON_WAKEUP CONF_CLOCK_DFLL_ENABLE_CHILL_CYCLE CONF_CLOCK_DFLL_MAX_COARSE_STEP_SIZE CONF_CLOCK_DFLL_MAX_FINE_STEP_SIZE
true true
(512) GCLK_GENERATOR_1 (48000000 / 32768) true true true true (0x1f / 4) (0xff / 4)
/* SYSTEM_CLOCK_SOURCE_DPLL configuration - Digital Phase-Locked Loop */
# #
define CONF_CLOCK_DPLL_ENABLE define CONF_CLOCK_DPLL_ON_DEMAND
false true
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
27
# # # #
define define define define
CONF_CLOCK_DPLL_RUN_IN_STANDBY CONF_CLOCK_DPLL_LOCK_BYPASS CONF_CLOCK_DPLL_WAKE_UP_FAST CONF_CLOCK_DPLL_LOW_POWER_ENABLE
false false false false
# define CONF_CLOCK_DPLL_LOCK_TIME SYSTEM_CLOCK_SOURCE_DPLL_LOCK_TIME_DEFAULT # define CONF_CLOCK_DPLL_REFERENCE_CLOCK SYSTEM_CLOCK_SOURCE_DPLL_REFERENCE_CLOCK_XOSC32K # define CONF_CLOCK_DPLL_FILTER SYSTEM_CLOCK_SOURCE_DPLL_FILTER_DEFAULT # # #
define CONF_CLOCK_DPLL_REFERENCE_FREQUENCY define CONF_CLOCK_DPLL_REFERENCE_DIVIDER define CONF_CLOCK_DPLL_OUTPUT_FREQUENCY
/* DPLL GCLK reference configuration */
#
define CONF_CLOCK_DPLL_REFERENCE_GCLK_GENERATOR
/* DPLL GCLK lock timer configuration */
#
32768 1 48000000
define CONF_CLOCK_DPLL_LOCK_GCLK_GENERATOR
GCLK_GENERATOR_1 GCLK_GENERATOR_1
/* Set this to true to configure the GCLK when running clocks_init. If set to * false, none of the GCLK generators will be configured in clocks_init(). */
#
define CONF_CLOCK_CONFIGURE_GCLK
/* Configure GCLK generator 0 (Main Clock) */
# # # # #
define define define define define
CONF_CLOCK_GCLK_0_ENABLE CONF_CLOCK_GCLK_0_RUN_IN_STANDBY CONF_CLOCK_GCLK_0_CLOCK_SOURCE CONF_CLOCK_GCLK_0_PRESCALER CONF_CLOCK_GCLK_0_OUTPUT_ENABLE
/* Configure GCLK generator 1 */
# define CONF_CLOCK_GCLK_1_ENABLE # define CONF_CLOCK_GCLK_1_RUN_IN_STANDBY # define CONF_CLOCK_GCLK_1_CLOCK_SOURCE SYSTEM_CLOCK_SOURCE_XOSC32K # define CONF_CLOCK_GCLK_1_PRESCALER # define CONF_CLOCK_GCLK_1_OUTPUT_ENABLE /* Configure GCLK generator 2 (RTC) */
# define CONF_CLOCK_GCLK_2_ENABLE # define CONF_CLOCK_GCLK_2_RUN_IN_STANDBY # define CONF_CLOCK_GCLK_2_CLOCK_SOURCE SYSTEM_CLOCK_SOURCE_OSC32K # define CONF_CLOCK_GCLK_2_PRESCALER # define CONF_CLOCK_GCLK_2_OUTPUT_ENABLE /* Configure GCLK generator 3 */
# # # # #
define define define define define
CONF_CLOCK_GCLK_3_ENABLE CONF_CLOCK_GCLK_3_RUN_IN_STANDBY CONF_CLOCK_GCLK_3_CLOCK_SOURCE CONF_CLOCK_GCLK_3_PRESCALER CONF_CLOCK_GCLK_3_OUTPUT_ENABLE
/* Configure GCLK generator 4 */
# # # # #
define define define define define
CONF_CLOCK_GCLK_4_ENABLE CONF_CLOCK_GCLK_4_RUN_IN_STANDBY CONF_CLOCK_GCLK_4_CLOCK_SOURCE CONF_CLOCK_GCLK_4_PRESCALER CONF_CLOCK_GCLK_4_OUTPUT_ENABLE
true
true true SYSTEM_CLOCK_SOURCE_DFLL 1 false false false 1 false false false 32 false false false SYSTEM_CLOCK_SOURCE_OSC8M 1 false false false SYSTEM_CLOCK_SOURCE_OSC8M 1 false
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
28
/* Configure GCLK generator 5 */
# # # # #
define define define define define
CONF_CLOCK_GCLK_5_ENABLE CONF_CLOCK_GCLK_5_RUN_IN_STANDBY CONF_CLOCK_GCLK_5_CLOCK_SOURCE CONF_CLOCK_GCLK_5_PRESCALER CONF_CLOCK_GCLK_5_OUTPUT_ENABLE
/* Configure GCLK generator 6 */
# # # # #
define define define define define
CONF_CLOCK_GCLK_6_ENABLE CONF_CLOCK_GCLK_6_RUN_IN_STANDBY CONF_CLOCK_GCLK_6_CLOCK_SOURCE CONF_CLOCK_GCLK_6_PRESCALER CONF_CLOCK_GCLK_6_OUTPUT_ENABLE
/* Configure GCLK generator 7 */
# # # # #
define define define define define
CONF_CLOCK_GCLK_7_ENABLE CONF_CLOCK_GCLK_7_RUN_IN_STANDBY CONF_CLOCK_GCLK_7_CLOCK_SOURCE CONF_CLOCK_GCLK_7_PRESCALER CONF_CLOCK_GCLK_7_OUTPUT_ENABLE
/* Configure GCLK generator 8 */
# # # # #
define define define define define
CONF_CLOCK_GCLK_8_ENABLE CONF_CLOCK_GCLK_8_RUN_IN_STANDBY CONF_CLOCK_GCLK_8_CLOCK_SOURCE CONF_CLOCK_GCLK_8_PRESCALER CONF_CLOCK_GCLK_8_OUTPUT_ENABLE
false false SYSTEM_CLOCK_SOURCE_OSC8M 1 false false false SYSTEM_CLOCK_SOURCE_OSC8M 1 false false false SYSTEM_CLOCK_SOURCE_OSC8M 1 false false false SYSTEM_CLOCK_SOURCE_OSC8M 1 false
#endif /* CONF_CLOCKS_H_INCLUDED */
4.4.
conf_board.h
4.4.1.
AT32UC3A0, AT32UC3A1, AT32UC3B Devices (USBB) /* * Support and FAQ: visit Atmel Support */
#ifndef CONF_BOARD_H_INCLUDED #define CONF_BOARD_H_INCLUDED
// Only the default board init (switchs/leds) is necessary for this example
#endif /* CONF_BOARD_H_INCLUDED */ 4.4.2.
AT32UC3A3 and AT32UC3A4 Devices (USBB with High Speed Support) /* * Support and FAQ: visit Atmel Support */
#ifndef CONF_BOARD_H_INCLUDED #define CONF_BOARD_H_INCLUDED
// Only the default board init (switchs/leds) is necessary for this example
#endif /* CONF_BOARD_H_INCLUDED */ Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
29
4.4.3.
AT32UC3C, ATUCXXD, ATUCXXL3U, ATUCXXL4U Devices (USBC) /* * Support and FAQ: visit Atmel Support */
#ifndef CONF_BOARD_H_INCLUDED #define CONF_BOARD_H_INCLUDED
// Only the default board init (switchs/leds) is necessary for this example
#endif /* CONF_BOARD_H_INCLUDED */ 4.4.4.
SAM3X and SAM3A Devices (UOTGHS: USB OTG High Speed) /* * Support and FAQ: visit Atmel Support */
#ifndef CONF_BOARD_H_INCLUDED #define CONF_BOARD_H_INCLUDED // USB pins are used
#define CONF_BOARD_USB_PORT #endif /* CONF_BOARD_H_INCLUDED */ 4.4.5.
SAM D21 Device (USB) /* * Support and FAQ: visit Atmel Support */
#ifndef CONF_BOARD_H_INCLUDED #define CONF_BOARD_H_INCLUDED /* Enable USB VBUS detect */
#define CONF_BOARD_USB_VBUS_DETECT #endif /* CONF_BOARD_H_INCLUDED */
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
30
5.
USB Device Basic Setup
5.1.
Custom Configuration The following USB Device configuration must be included in the conf_usb.h file of the application: 1. USB_DEVICE_VENDOR_ID (Word). Vendor ID provided by USB org (Atmel 0x03EB). 2. USB_DEVICE_PRODUCT_ID (Word). Product ID (Referenced in usb_atmel.h). 3. USB_DEVICE_MAJOR_VERSION (Byte). Major version of the device. 4. USB_DEVICE_MINOR_VERSION (Byte). Minor version of the device. 5. USB_DEVICE_MANUFACTURE_NAME (string). ASCII name for the manufacture. 6. USB_DEVICE_PRODUCT_NAME (string). ASCII name for the product. 7. USB_DEVICE_SERIAL_NAME (string). ASCII name to enable and set a serial number. 8. USB_DEVICE_POWER (Numeric). (unit mA) Maximum device power. 9. USB_DEVICE_ATTR (Byte). USB attributes available: • USB_CONFIG_ATTR_SELF_POWERED • USB_CONFIG_ATTR_REMOTE_WAKEUP Note: If remote wake is enabled, this defines remotewakeup callbacks. 10. USB_DEVICE_LOW_SPEED (Only defined). Force the USB Device to run in low speed. 11. USB_DEVICE_HS_SUPPORT (Only defined). Authorize the USB Device to run in high speed. 12. USB_DEVICE_MAX_EP (Byte). Define the maximum endpoint number used by the USB Device. This one is already defined in the UDI default configuration. E.g.: • When endpoint control 0x00, endpoint 0x01, and endpoint 0x82 is used, then USB_DEVICE_MAX_EP=2 • When only endpoint control 0x00 is used, then USB_DEVICE_MAX_EP=0 Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
31
•
5.2.
When endpoint 0x01 and endpoint 0x81 is used, then USB_DEVICE_MAX_EP=1 (configuration not possible on USBB interface)
VBUS Monitoring The VBUS monitoring is used only for USB SELF Power application. •
By default the USB device is automatically attached when VBUS is high or when USB starts for devices without internal VBUS monitoring. conf_usb.h file does not contain definition USB_DEVICE_ATTACH_AUTO_DISABLE. //#define USB_DEVICE_ATTACH_AUTO_DISABLE
•
Add custom VBUS monitoring. conf_usb.h file contains define USB_DEVICE_ATTACH_AUTO_DISABLE: #define USB_DEVICE_ATTACH_AUTO_DISABLE User C-file contains: // Authorize VBUS monitoring if (!udc_include_vbus_monitoring()) { // Implement custom VBUS monitoring via GPIO or other
} Event_VBUS_present() // VBUS interrupt or GPIO interrupt or other { // Attach USB Device
} •
udc_attach();
Case of battery charging. conf_usb.h file contains define USB_DEVICE_ATTACH_AUTO_DISABLE: #define USB_DEVICE_ATTACH_AUTO_DISABLE User C-file contains: Event VBUS present() // VBUS interrupt or GPIO interrupt or .. { // Authorize battery charging, but wait key press to start USB.
} Event Key press() {
// Stop batteries charging // Start USB
}
udc_attach();
5.3.
USB Device Basic Setup
5.3.1.
USB Device Controller (UDC) - Prerequisites Common prerequisites for all USB devices. ®
This module is based on USB device stack full interrupt driven, and supporting sleepmgr. For AVR and ® ® Atmel | SMART ARM -based SAM3/4 devices the clock services is supported. For SAM D21 devices the clock driver is supported. The following procedure must be executed to set up the project correctly: Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
32
•
Specify the clock configuration: ® • XMEGA USB devices need 48MHz clock input. XMEGA USB devices need CPU frequency higher than 12MHz. You can use either an internal RC 48MHz auto calibrated by Start of Frames or an external OSC. • UC3 and SAM3/4 devices without USB high speed support need 48MHz clock input. You must use a PLL and an external OSC. • UC3 and SAM3/4 devices with USB high speed support need 12MHz clock input. You must use an external OSC. • UC3 devices with USBC hardware need CPU frequency higher than 25MHz •
• • •
SAM D21 devices without USB high speed support need 48MHz clock input. You should use DFLL with USBCRM. In conf_board.h, the define CONF_BOARD_USB_PORT must be added to enable USB lines. (Not mandatory for all boards). Enable interrupts Initialize the clock service
The usage of sleep manager service is optional, but recommended to reduce power consumption: • Initialize the sleep manager service • Activate sleep mode when the application is in IDLE state For AVR and SAM3/4 devices, add to the initialization code: sysclk_init(); irq_initialize_vectors(); cpu_irq_enable(); board_init(); sleepmgr_init(); // Optional For SAM D21 devices, add to the initialization code: system_init(); irq_initialize_vectors(); cpu_irq_enable(); sleepmgr_init(); // Optional Add to the main IDLE loop: sleepmgr_enter_sleep(); // Optional 5.3.2.
USB Device Controller (UDC) - Example Code Common example code for all USB devices. Content of conf_usb.h: #define #define #define #define #define #define
USB_DEVICE_VENDOR_ID 0x03EB USB_DEVICE_PRODUCT_ID 0xXXXX USB_DEVICE_MAJOR_VERSION 1 USB_DEVICE_MINOR_VERSION 0 USB_DEVICE_POWER 100 USB_DEVICE_ATTR USB_CONFIG_ATTR_BUS_POWERED
Add to application C-file: void usb_init(void)
{
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
33
} 5.3.3.
udc_start();
USB Device Controller (UDC) - Workflow Common workflow for all USB devices. 1.
Ensure that conf_usb.h is available and contains the following configuration, which is the main USB device configuration: // Vendor ID provided by USB org (Atmel 0x03EB)
#define USB_DEVICE_VENDOR_ID 0x03EB // Type Word // Product ID (Atmel PID referenced in usb_atmel.h)
#define USB_DEVICE_PRODUCT_ID 0xXXXX // Type Word // Major version of the device
#define USB_DEVICE_MAJOR_VERSION 1 // Type Byte // Minor version of the device
#define USB_DEVICE_MINOR_VERSION 0 // Type Byte // Maximum device power (mA)
#define USB_DEVICE_POWER 100 // Type 9-bits // USB attributes to enable features
#define USB_DEVICE_ATTR USB_CONFIG_ATTR_BUS_POWERED // Flags 2.
Call the USB device stack start function to enable stack and start USB: udc_start(); Note: In case of USB dual roles (Device and Host) managed through USB OTG connector (USB ID pin), the call of udc_start() must be removed and replaced by uhc_start(). Refer to section "Dual roles" for further information in the application note: Atmel AVR4950: ASF - USB Host Stack
5.4.
conf_clock.h Examples Content of XMEGA conf_clock.h: // Configuration based on internal RC: // USB clock need of 48MHz
#define CONFIG_USBCLK_SOURCE USBCLK_SRC_RCOSC #define CONFIG_OSC_RC32_CAL 48000000UL #define CONFIG_OSC_AUTOCAL_RC32MHZ_REF_OSC OSC_ID_USBSOF // CPU clock need of clock > 12MHz to run with USB (Here 24MHz)
#define CONFIG_SYSCLK_SOURCE #define CONFIG_SYSCLK_PSADIV #define CONFIG_SYSCLK_PSBCDIV
SYSCLK_SRC_RC32MHZ SYSCLK_PSADIV_2 SYSCLK_PSBCDIV_1_1
Content of conf_clock.h for AT32UC3A0, AT32UC3A1, and AT32UC3B devices (USBB): // Configuration based on 12MHz external OSC:
#define #define #define #define #define
CONFIG_PLL1_SOURCE CONFIG_PLL1_MUL CONFIG_PLL1_DIV CONFIG_USBCLK_SOURCE CONFIG_USBCLK_DIV
PLL_SRC_OSC0 8 2 USBCLK_SRC_PLL1 1 // Fusb = Fsys/(2 ^ USB_div)
Content of conf_clock.h for AT32UC3A3 and AT32UC3A4 devices (USBB with high speed support): // Configuration based on 12MHz external OSC:
#define CONFIG_USBCLK_SOURCE #define CONFIG_USBCLK_DIV
USBCLK_SRC_OSC0 1 // Fusb = Fsys/(2 ^ USB_div)
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
34
Content of conf_clock.h for AT32UC3C, ATUCXXD, ATUCXXL3U, and ATUCXXL4U devices (USBC): // Configuration based on 12MHz external OSC:
#define #define #define #define #define
CONFIG_PLL1_SOURCE CONFIG_PLL1_MUL CONFIG_PLL1_DIV CONFIG_USBCLK_SOURCE CONFIG_USBCLK_DIV
PLL_SRC_OSC0 8 2 USBCLK_SRC_PLL1 1 // Fusb = Fsys/(2 ^ USB_div)
// CPU clock need of clock > 25MHz to run with USBC
#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_PLL1
Content of conf_clock.h for SAM3S, SAM3SD, and SAM4S devices (UPD: USB Peripheral Device): // PLL1 (B) Options
(Fpll = (Fclk * PLL_mul) / PLL_div)
#define CONFIG_PLL1_SOURCE #define CONFIG_PLL1_MUL #define CONFIG_PLL1_DIV // USB Clock Source Options
PLL_SRC_MAINCK_XTAL 16 2
(Fusb = FpllX / USB_div)
#define CONFIG_USBCLK_SOURCE #define CONFIG_USBCLK_DIV
USBCLK_SRC_PLL1 2
Content of conf_clock.h for SAM3U device (UPDHS: USB Peripheral Device High Speed): // USB Clock Source fixed at UPLL.
Content of conf_clock.h for SAM3X and SAM3A devices (UOTGHS: USB OTG High Speed): // USB Clock Source fixed at UPLL.
#define CONFIG_USBCLK_SOURCE #define CONFIG_USBCLK_DIV
USBCLK_SRC_UPLL 1
Content of conf_clocks.h for SAM D21 devices (USB): // System clock bus configuration
#
define CONF_CLOCK_FLASH_WAIT_STATES
2
// USB Clock Source fixed at DFLL. // SYSTEM_CLOCK_SOURCE_DFLL configuration - Digital Frequency Locked Loop
# define CONF_CLOCK_DFLL_ENABLE # define CONF_CLOCK_DFLL_LOOP_MODE SYSTEM_CLOCK_DFLL_LOOP_MODE_USB_RECOVERY # define CONF_CLOCK_DFLL_ON_DEMAND
true true
// Set this to true to configure the GCLK when running clocks_init. // If set to false, none of the GCLK generators will be configured in clocks_init().
#
define CONF_CLOCK_CONFIGURE_GCLK
// Configure GCLK generator 0 (Main Clock)
# # # # #
define define define define define
CONF_CLOCK_GCLK_0_ENABLE CONF_CLOCK_GCLK_0_RUN_IN_STANDBY CONF_CLOCK_GCLK_0_CLOCK_SOURCE CONF_CLOCK_GCLK_0_PRESCALER CONF_CLOCK_GCLK_0_OUTPUT_ENABLE
true
true true SYSTEM_CLOCK_SOURCE_DFLL 1 false
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
35
6.
Document Revision History Doc. Rev.
Date
Comments
42341B
12/2015
Fixed typos
42341A
12/2014
Initial release
Atmel AT09336: USB Device Interface (UDI) for Human Interface Device Mouse (HID Mouse) [APPLICATION NOTE] Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015
36
Atmel Corporation
©
1600 Technology Drive, San Jose, CA 95110 USA
T: (+1)(408) 441.0311
F: (+1)(408) 436.4200
|
www.atmel.com
2015 Atmel Corporation. / Rev.: Atmel-42341B-USB-Device-Interface-UDI-for-Human-Interface-Device-Mouse-HID-Mouse_AT09336_Application Note-12/2015 ®
®
®
®
Atmel , Atmel logo and combinations thereof, Enabling Unlimited Possibilities , AVR , XMEGA , and others are registered trademarks or trademarks of Atmel ® ® Corporation in U.S. and other countries. ARM , ARM Connected logo, and others are registered trademarks of ARM Ltd. Other terms and product names may be trademarks of others. DISCLAIMER: The information in this document is provided in connection with Atmel products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Atmel products. EXCEPT AS SET FORTH IN THE ATMEL TERMS AND CONDITIONS OF SALES LOCATED ON THE ATMEL WEBSITE, ATMEL ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS AND PROFITS, BUSINESS INTERRUPTION, OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF ATMEL HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Atmel makes no representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right to make changes to specifications and products descriptions at any time without notice. Atmel does not make any commitment to update the information contained herein. Unless specifically provided otherwise, Atmel products are not suitable for, and shall not be used in, automotive applications. Atmel products are not intended, authorized, or warranted for use as components in applications intended to support or sustain life. SAFETY-CRITICAL, MILITARY, AND AUTOMOTIVE APPLICATIONS DISCLAIMER: Atmel products are not designed for and will not be used in connection with any applications where the failure of such products would reasonably be expected to result in significant personal injury or death (“Safety-Critical Applications”) without an Atmel officer's specific written consent. Safety-Critical Applications include, without limitation, life support devices and systems, equipment or systems for the operation of nuclear facilities and weapons systems. Atmel products are not designed nor intended for use in military or aerospace applications or environments unless specifically designated by Atmel as military-grade. Atmel products are not designed nor intended for use in automotive applications unless specifically designated by Atmel as automotive-grade.
