Atmel Microcontrollers
AT09341: USB Host Interface (UHI) for Vendor
Class Device
APPLICATION NOTE
Introduction
USB Host Interface (UHI) for Vendor Class Device provides an interface for
the configuration and management of USB Vendor host.
The outline of this documentation is as follows:
•
API Overview
•
Quick Start Guide for USB Host Vendor Module (UHI Vendor)
•
Configuration File Examples
®
For more details for Atmel Software Framework (ASF) USB Host Stack,
refer to following application note:
•
AVR4950: ASF - USB Host Stack
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
Table of Contents
Introduction......................................................................................................................1
1. Software License....................................................................................................... 4
2. API Overview............................................................................................................. 5
2.1.
Macro Definitions..........................................................................................................................5
2.1.1.
Interface with USB Host Core (UHC).............................................................................5
2.2.
Function Definitions......................................................................................................................5
2.2.1.
Functions Required by UHC.......................................................................................... 5
2.2.2.
UHI for Vendor Class..................................................................................................... 6
3. Quick Start Guide for USB Host Vendor Module (UHI Vendor)............................... 11
3.1.
3.2.
3.3.
3.4.
3.5.
Basic Use Case.......................................................................................................................... 11
3.1.1.
Setup Steps..................................................................................................................11
3.1.2.
Usage Steps.................................................................................................................11
Advanced Use Cases.................................................................................................................12
Enable USB High Speed Support.............................................................................................. 12
3.3.1.
Setup Steps................................................................................................................. 12
3.3.2.
Usage Steps................................................................................................................ 13
Multiple Classes Support............................................................................................................13
3.4.1.
Setup Steps................................................................................................................. 13
3.4.2.
Usage Steps................................................................................................................ 13
Dual Roles Support.................................................................................................................... 13
3.5.1.
Setup Steps................................................................................................................. 13
3.5.2.
Usage Steps................................................................................................................ 14
4. Configuration File Examples....................................................................................16
4.1.
4.2.
4.3.
4.4.
conf_usb_host.h......................................................................................................................... 16
4.1.1.
UHI Vendor Single....................................................................................................... 16
4.1.2.
UHI Vendor Multiple (Composite)................................................................................ 17
conf_clock.h................................................................................................................................18
4.2.1.
SAM3X and SAM3A Devices (UOTGHS: USB OTG High Speed)..............................18
4.2.2.
SAM4L Device (USBC)................................................................................................19
conf_clocks.h..............................................................................................................................20
4.3.1.
SAM D21 Devices (USB).............................................................................................20
conf_board.h...............................................................................................................................23
4.4.1.
SAM3X and SAM3A Devices (UOTGHS: USB OTG High Speed)..............................23
4.4.2.
SAM4L Device (USBC)................................................................................................24
4.4.3.
SAM D21 Devices (USB).............................................................................................25
5. USB Host Basic Setup.............................................................................................26
5.1.
5.2.
5.3.
USB Host User Configuration.....................................................................................................26
USB Host User Callback............................................................................................................ 26
USB Host Setup Steps............................................................................................................... 27
5.3.1.
USB Host Controller (UHC) - Prerequisites................................................................. 27
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
2
5.3.2.
5.4.
USB Host Controller (UHC) - Example Code.............................................................. 27
5.3.3.
USB Device Controller (UHC) - Workflow....................................................................28
conf_clock.h Examples...............................................................................................................28
6. Document Revision History..................................................................................... 30
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_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 AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
4
2.
API Overview
2.1.
Macro Definitions
2.1.1.
Interface with USB Host Core (UHC)
Definition and functions required by UHC.
2.1.1.1.
Macro UHI_VENDOR
#define UHI_VENDOR
Global definition which contains standard UHI API for UHC It must be added in USB_HOST_UHI
definition from conf_usb_host.h file.
2.2.
Function Definitions
2.2.1.
Functions Required by UHC
2.2.1.1.
Function uhi_vendor_install()
Install interface.
uhc_enum_status_t uhi_vendor_install(
uhc_device_t * dev)
Allocate interface endpoints if supported.
Table 2-1. Parameters
Data direction
Parameter name
Description
[in]
uhc_device_t
Device to request
Returns
Status of the install.
2.2.1.2.
Function uhi_vendor_enable()
Enable the interface.
void uhi_vendor_enable(
uhc_device_t * dev)
Enable a USB interface corresponding to UHI.
Table 2-2. Parameters
Data direction
Parameter name
Description
[in]
uhc_device_t
Device to request
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
5
2.2.1.3.
Function uhi_vendor_uninstall()
Uninstall the interface (if installed).
void uhi_vendor_uninstall(
uhc_device_t * dev)
Table 2-3. Parameters
2.2.2.
Data direction
Parameter name
Description
[in]
uhc_device_t
Device to request
UHI for Vendor Class
Common APIs used by high level application to use this USB host class.
This Vendor Class implementation supports one endpoint for all endpoint types on all directions: Control
IN, control OUT, interrupt IN, interrupt OUT, bulk IN, bulk OUT, isochronous IN, isochronous OUT.
This implementation is an example and can be a base to create another Vendor Class which supports
more endpoint as two bulk IN endpoints.
2.2.2.1.
Function uhi_vendor_control_in_run()
Start a transfer on control IN.
bool uhi_vendor_control_in_run(
uint8_t * buf,
iram_size_t buf_size,
uhd_callback_setup_end_t callback)
When the transfer is finished or aborted (stall, reset, ...), the callback is called. The callback returns the
transfer status and eventually the number of bytes transferred.
Table 2-4. Parameters
Data direction Parameter name Description
[out]
buf
Buffer on Internal RAM to send or fill. It must be align, then use
COMPILER_WORD_ALIGNED.
[in]
buf_size
Buffer size to send or fill
[in]
callback
NULL or function to call at the end of transfer
Returns
1 if function was successfully done, otherwise 0.
2.2.2.2.
Function uhi_vendor_control_out_run()
Start a transfer on control OUT.
bool uhi_vendor_control_out_run(
uint8_t * buf,
iram_size_t buf_size,
uhd_callback_setup_end_t callback)
When the transfer is finished or aborted (stall, reset, ...), the callback is called. The callback returns the
transfer status and eventually the number of byte transferred.
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
6
Table 2-5. Parameters
Data direction Parameter name Description
[in]
buf
Buffer on Internal RAM to send or fill. It must be align, then use
COMPILER_WORD_ALIGNED.
[in]
buf_size
Buffer size to send or fill
[in]
callback
NULL or function to call at the end of transfer
Returns
1 if function was successfully done, otherwise 0.
2.2.2.3.
Function uhi_vendor_bulk_in_run()
Start a transfer on bulk IN.
bool uhi_vendor_bulk_in_run(
uint8_t * buf,
iram_size_t buf_size,
uhd_callback_trans_t callback)
When the transfer is finished or aborted (stall, reset, ...), the callback is called. The callback returns the
transfer status and eventually the number of byte transferred.
Table 2-6. Parameters
Data direction Parameter name Description
[out]
buf
Buffer on Internal RAM to send or fill. It must be align, then use
COMPILER_WORD_ALIGNED.
[in]
buf_size
Buffer size to send or fill
[in]
callback
NULL or function to call at the end of transfer
Returns
1 if function was successfully done, otherwise 0.
2.2.2.4.
Function uhi_vendor_bulk_out_run()
Start a transfer on bulk OUT.
bool uhi_vendor_bulk_out_run(
uint8_t * buf,
iram_size_t buf_size,
uhd_callback_trans_t callback)
When the transfer is finished or aborted (stall, reset, ...), the callback is called. The callback returns the
transfer status and eventually the number of byte transferred.
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
7
Table 2-7. Parameters
Data direction Parameter name Description
[in]
buf
Buffer on Internal RAM to send or fill. It must be align, then use
COMPILER_WORD_ALIGNED.
[in]
buf_size
Buffer size to send or fill
[in]
callback
NULL or function to call at the end of transfer
Returns
1 if function was successfully done, otherwise 0.
2.2.2.5.
Function uhi_vendor_int_in_run()
Start a transfer on interrupt IN.
bool uhi_vendor_int_in_run(
uint8_t * buf,
iram_size_t buf_size,
uhd_callback_trans_t callback)
When the transfer is finished or aborted (stall, reset, ...), the callback is called. The callback returns the
transfer status and eventually the number of byte transferred.
Table 2-8. Parameters
Data direction Parameter name Description
[out]
buf
Buffer on Internal RAM to send or fill. It must be align, then use
COMPILER_WORD_ALIGNED.
[in]
buf_size
Buffer size to send or fill
[in]
callback
NULL or function to call at the end of transfer
Returns
1 if function was successfully done, otherwise 0.
2.2.2.6.
Function uhi_vendor_int_out_run()
Start a transfer on interrupt OUT.
bool uhi_vendor_int_out_run(
uint8_t * buf,
iram_size_t buf_size,
uhd_callback_trans_t callback)
When the transfer is finished or aborted (stall, reset, ...), the callback is called. The callback returns the
transfer status and eventually the number of byte transferred.
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
8
Table 2-9. Parameters
Data direction Parameter name Description
[in]
buf
Buffer on Internal RAM to send or fill. It must be align, then use
COMPILER_WORD_ALIGNED.
[in]
buf_size
Buffer size to send or fill
[in]
callback
NULL or function to call at the end of transfer
Returns
1 if function was successfully done, otherwise 0.
2.2.2.7.
Function uhi_vendor_iso_in_run()
Start a transfer on ISO IN.
bool uhi_vendor_iso_in_run(
uint8_t * buf,
iram_size_t buf_size,
uhd_callback_trans_t callback)
When the transfer is finished or aborted (stall, reset, ...), the callback is called. The callback returns the
transfer status and eventually the number of byte transferred.
Table 2-10. Parameters
Data direction Parameter name Description
[out]
buf
Buffer on Internal RAM to send or fill. It must be align, then use
COMPILER_WORD_ALIGNED.
[in]
buf_size
Buffer size to send or fill
[in]
callback
NULL or function to call at the end of transfer
Returns
1 if function was successfully done, otherwise 0.
2.2.2.8.
Function uhi_vendor_iso_out_run()
Start a transfer on ISO OUT.
bool uhi_vendor_iso_out_run(
uint8_t * buf,
iram_size_t buf_size,
uhd_callback_trans_t callback)
When the transfer is finished or aborted (stall, reset, ...), the callback is called. The callback returns the
transfer status and eventually the number of byte transferred.
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
9
Table 2-11. Parameters
Data direction Parameter name Description
[in]
buf
Buffer on Internal RAM to send or fill. It must be align, then use
COMPILER_WORD_ALIGNED.
[in]
buf_size
Buffer size to send or fill
[in]
callback
NULL or function to call at the end of transfer
Returns
1 if function was successfully done, otherwise 0.
2.2.2.9.
Function uhi_vendor_bulk_is_available()
Check if a transfer on BULK is possible.
bool uhi_vendor_bulk_is_available( void )
Returns
1 if possible, otherwise 0.
2.2.2.10. Function uhi_vendor_int_is_available()
Check if a transfer on INTERRUPT is possible.
bool uhi_vendor_int_is_available( void )
Returns
1 if possible, otherwise 0.
2.2.2.11. Function uhi_vendor_iso_is_available()
Check if a transfer on ISO is possible.
bool uhi_vendor_iso_is_available( void )
Returns
1 if possible, otherwise 0.
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
10
3.
Quick Start Guide for USB Host Vendor Module (UHI Vendor)
This is the quick start guide for the USB Host Vendor Module (UHI Vendor) with step-by-step instructions
on how to configure and use the modules in a selection of use cases.
The use cases highlights 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 Vendor (Single Class support)" module is used.
The "USB Vendor (Composite)" module usage is described in Advanced Use Cases.
3.1.1.
Setup Steps
As a USB host, it follows common USB host setup steps. Refer to USB Host Basic Setup.
3.1.2.
Usage Steps
3.1.2.1.
Example Code
Content of conf_usb_host.h:
#define USB_HOST_UHI
UHI_VENDOR
#define UHI_VENDOR_CHANGE(dev, b_plug) my_callback_vendor_change(dev,
b_plug)
extern void my_callback_vendor_change(uhc_device_t* dev, bool b_plug);
#define UHI_VENDOR_VID_PID_LIST {USB_VID_ATMEL,
USB_PID_ATMEL_ASF_VENDOR_CLASS}
#include "uhi_vendor.h" // At the end of conf_usb_host.h file
Add to application C-file:
static bool my_flag_vendor_test_start = false;
void my_callback_vendor_change(uhc_device_t* dev, bool b_plug)
{
// USB Device Vendor connected
my_flag_vendor_test_start = b_plug;
}
static void my_callback_bulk_in_done (usb_add_t add,
{
usb_ep_t ep, uhd_trans_status_t status, iram_size_t nb_transfered)
if (status != UHD_TRANS_NOERROR) {
return; // Error during transfer
}
}
// Data received then restart test
my_flag_vendor_test_start = true;
#define MESSAGE "Hello bulk"
#define HELLO_SIZE 5
#define HELLO_BULK_SIZE 10
uint8_t my_out_buffer[MESSAGE_SIZE+1] = MESSAGE;
uint8_t my_in_buffer[MESSAGE_SIZE+1];
void my_task(void)
{
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
11
if (!my_flag_vendor_test_start) {
return;
}
my_flag_vendor_test_start = false;
// Send data through control endpoint
uhi_vendor_control_out_run(my_out_buffer, HELLO_SIZE, NULL);
// Check if bulk endpoints are available
if (uhi_vendor_bulk_is_available()) {
// Send data through bulk OUT endpoint
uhi_vendor_bulk_out_run(my_out_buffer, HELLO_BULK_SIZE, NULL);
// Receive data through bulk IN endpoint
}
3.1.2.2.
}
uhi_vendor_bulk_in_run(my_in_buffer, sizeof(my_in_buffer),
my_callback_bulk_in_done);
Workflow
1.
Ensure that conf_usb_host.h is available and contains the following configurations, which is the
USB host vendor configuration:
#define USB_HOST_UHI
UHI_HID_VENDOR
Note: It defines the list of UHI supported by USB host.
#define UHI_VENDOR_CHANGE(dev, b_plug) my_callback_vendor_change(dev,
b_plug)
extern bool my_callback_vendor_change(uhc_device_t* dev, bool b_plug);
Note: This callback is called when a USB device vendor is plugged or unplugged.
#define UHI_VENDOR_VID_PID_LIST {USB_VID_ATMEL,
USB_PID_ATMEL_ASF_VENDOR_CLASS}
2.
Note: It defines the list of devices supported by USB host (defined by VID and PID).
The Vendor data transfert functions are described in uhi_vendor_group.
uhi_vendor_control_out_run(), uhi_vendor_bulk_out_run(),...
3.2.
Advanced Use Cases
For more advanced use of the UHI vendor module, see the following use cases:
•
Enable USB High Speed Support
•
Multiple Classes Support
•
Dual Roles Support
3.3.
Enable USB High Speed Support
In this use case, the USB host is used to support USB high speed.
3.3.1.
Setup Steps
Prior to implement this use case, be sure to have already applied the UHI module "basic use case".
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
12
3.3.2.
Usage Steps
3.3.2.1.
Example Code
Content of conf_usb_host.h:
#define USB_HOST_HS_SUPPORT
3.3.2.2.
Workflow
1.
Ensure that conf_usb_host.h is available and contains the following parameters required for a USB
device high speed (480Mbit/s):
#define
3.4.
USB_HOST_HS_SUPPORT
Multiple Classes Support
In this use case, the USB host is used to support several USB classes.
3.4.1.
Setup Steps
Prior to implement this use case, be sure to have already applied the UHI module "basic use case".
3.4.2.
Usage Steps
3.4.2.1.
Example Code
Content of conf_usb_host.h:
#define USB_HOST_UHI
3.4.2.2.
UHI_HID_MOUSE, UHI_MSC, UHI_CDC
Workflow
1.
Ensure that conf_usb_host.h is available and contains the following parameters:
#define USB_HOST_UHI
UHI_HID_MOUSE, UHI_MSC, UHI_CDC
Note: USB_HOST_UHI defines the list of UHI supported by USB host. Here, you must add all
classes that you want to support.
3.5.
Dual Roles Support
In this use case, the USB host and USB device are enabled, it is the dual role.
Note: On the Atmel boards, the switch of USB role is managed automatically by the USB stack thank to
a USB On-The-Go (OTG) connector and its USB ID pin. Refer to section "Dual roles" for further
information in the application note:
•
Atmel AVR4950: ASF - USB Host Stack
3.5.1.
Setup Steps
Prior to implement this use case, be sure to have already applied the UHI module "basic use case".
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
13
3.5.2.
Usage Steps
3.5.2.1.
Example Code
Content of conf_usb_host.h:
#define UHC_MODE_CHANGE(b_host_mode)
my_callback_mode_change(b_host_mode)
extern void my_callback_mode_change(bool b_host_mode);
Add to application C-file:
void usb_init(void)
{
//udc_start();
}
uhc_start();
bool my_host_mode;
void my_callback_mode_change(bool b_host_mode)
{
}
my_host_mode = b_host_mode;
void my_usb_task(void)
{
}
3.5.2.2.
if (my_host_mode) {
// CALL USB Host task
} else {
// CALL USB Device task
}
Workflow
1.
In case of USB dual roles (Device and Host), the USB stack must be enabled by uhc_start()
and the udc_start() must not be called.
//udc_start();
uhc_start();
2.
In dual role, to know the current USB mode, the callback to notify the mode changes can be used.
•
Ensure that conf_usb_host.h contains the following parameters:
#define UHC_MODE_CHANGE(b_host_mode)
my_callback_mode_change(b_host_mode)
extern void my_callback_mode_change(bool b_host_mode);
•
Ensure that application contains the following code:
bool my_host_mode;
void my_callback_mode_change(bool b_host_mode)
{
}
my_host_mode = b_host_mode;
void my_usb_task(void)
{
if (my_host_mode) {
// CALL USB Host task
} else {
// CALL USB Device task
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
14
}
}
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
15
4.
Configuration File Examples
4.1.
conf_usb_host.h
4.1.1.
UHI Vendor Single
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel
Support</a>
*/
#ifndef _CONF_USB_HOST_H_
#define _CONF_USB_HOST_H_
#include "compiler.h"
#define USB_HOST_UHI
UHI_VENDOR
#define USB_HOST_POWER_MAX
500
// #define USB_HOST_HUB_SUPPORT
#if (UC3A3 || UC3A4)
# define USB_HOST_HS_SUPPORT
#elif (SAM3XA)
# define USB_HOST_HS_SUPPORT
#endif
//#define UHC_MODE_CHANGE(b_host_mode)
usb_host_mode_change(b_host_mode)
//#define UHC_VBUS_CHANGE(b_present)
usb_host_vbus_change(b_present)
//#define UHC_VBUS_ERROR()
usb_host_vbus_error()
//#define UHC_CONNECTION_EVENT(dev,b_present)
usb_host_connection_event(dev,b_present)
//#define UHC_WAKEUP_EVENT()
usb_host_wakeup_event()
//#define UHC_SOF_EVENT()
usb_host_sof_event()
//#define UHC_DEVICE_CONF(dev)
uint8_t usb_host_device_conf(dev)
//#define UHC_ENUM_EVENT(dev,b_status)
usb_host_enum_event(dev,b_status)
#define UHI_VENDOR_CHANGE(dev, b_plug)
#define UHI_VENDOR_VID_PID_LIST {USB_VID_ATMEL,
USB_PID_ATMEL_ASF_VENDOR_CLASS}
#include "uhi_vendor.h"
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
16
#endif // _CONF_USB_HOST_H_
4.1.2.
UHI Vendor Multiple (Composite)
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel
Support</a>
*/
#ifndef _CONF_USB_HOST_H_
#define _CONF_USB_HOST_H_
#include "compiler.h"
#define USB_HOST_UHI
// UHI_MSC, UHI_HID_MOUSE, UHI_CDC, UHI_VENDOR
#define USB_HOST_POWER_MAX
500
// #define USB_HOST_HUB_SUPPORT
#if (UC3A3 || UC3A4)
# define USB_HOST_HS_SUPPORT
#endif
//#define UHC_MODE_CHANGE(b_host_mode)
usb_host_mode_change(b_host_mode)
//#define UHC_VBUS_CHANGE(b_present)
usb_host_vbus_change(b_present)
//#define UHC_VBUS_ERROR()
usb_host_vbus_error()
//#define UHC_CONNECTION_EVENT(dev,b_present)
usb_host_connection_event(dev,b_present)
//#define UHC_WAKEUP_EVENT()
usb_host_wakeup_event()
//#define UHC_SOF_EVENT()
usb_host_sof_event()
//#define UHC_DEVICE_CONF(dev)
uint8_t usb_host_device_conf(dev)
//#define UHC_ENUM_EVENT(dev,b_status)
usb_host_enum_event(dev,b_status)
#define
#define
#define
#define
#define
UHI_HID_MOUSE_CHANGE(dev,b_plug)
UHI_HID_MOUSE_EVENT_BTN_LEFT(b_state)
UHI_HID_MOUSE_EVENT_BTN_RIGHT(b_state)
UHI_HID_MOUSE_EVENT_BTN_MIDDLE(b_state)
UHI_HID_MOUSE_EVENT_MOUVE(x,y,scroll)
#define UHI_MSC_CHANGE(dev,b_plug)
#define UHI_CDC_CHANGE(dev,b_plug)
#define UHI_CDC_RX_NOTIFY()
#define UHI_VENDOR_CHANGE(dev, b_plug)
#define UHI_VENDOR_VID_PID_LIST {USB_VID_ATMEL,
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
17
USB_PID_ATMEL_ASF_VENDOR_CLASS}
//#include "uhi_msc.h"
//#include "uhi_hid_mouse.h"
#endif // _CONF_USB_HOST_H_
4.2.
conf_clock.h
4.2.1.
SAM3X and SAM3A Devices (UOTGHS: USB OTG High Speed)
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel
Support</a>
*/
#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
#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
SYSCLK_PRES_2
CONFIG_SYSCLK_PRES
CONFIG_SYSCLK_PRES
CONFIG_SYSCLK_PRES
CONFIG_SYSCLK_PRES
CONFIG_SYSCLK_PRES
CONFIG_SYSCLK_PRES
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
(Fusb = FpllX / USB_div)
Use div effective value here. */
//#define CONFIG_USBCLK_SOURCE
USBCLK_SRC_PLL0
#define CONFIG_USBCLK_SOURCE
#define CONFIG_USBCLK_DIV
USBCLK_SRC_UPLL
1
/*
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
18
===== 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 devider: 1 (not devided)
- UPLL frequency: 480MHz
- USB clock: 480 / 1 = 480MHz
*/
#endif /* CONF_CLOCK_H_INCLUDED */
4.2.2.
SAM4L Device (USBC)
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel
Support</a>
*/
#ifndef CONF_CLOCK_H_INCLUDED
#define CONF_CLOCK_H_INCLUDED
//#define
//#define
//#define
//#define
//#define
//#define
CONFIG_SYSCLK_INIT_CPUMASK
CONFIG_SYSCLK_INIT_PBAMASK
CONFIG_SYSCLK_INIT_PBBMASK
CONFIG_SYSCLK_INIT_PBCMASK
CONFIG_SYSCLK_INIT_PBDMASK
CONFIG_SYSCLK_INIT_HSBMASK
(1
(1
(1
(1
(1
(1
<<
<<
<<
<<
<<
<<
SYSCLK_OCD)
SYSCLK_IISC)
SYSCLK_USBC_REGS)
SYSCLK_CHIPID)
SYSCLK_AST)
SYSCLK_PDCA_HSB)
//#define CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_RCSYS
//#define
//#define
//#define
//#define
//#define
CONFIG_SYSCLK_SOURCE
CONFIG_SYSCLK_SOURCE
CONFIG_SYSCLK_SOURCE
CONFIG_SYSCLK_SOURCE
CONFIG_SYSCLK_SOURCE
SYSCLK_SRC_PLL0
SYSCLK_SRC_DFLL
SYSCLK_SRC_RC80M
SYSCLK_SRC_RCFAST
SYSCLK_SRC_RC1M
/* RCFAST
//#define
//#define
//#define
frequency selection: 0 for 4MHz, 1 for 8MHz and 2 for 12MHz */
CONFIG_RCFAST_FRANGE
0
CONFIG_RCFAST_FRANGE
1
CONFIG_RCFAST_FRANGE
2
#define CONFIG_SYSCLK_SOURCE
/* Fbus = Fsys / (2 ^ BUS_div) */
#define
#define
#define
#define
#define
CONFIG_SYSCLK_CPU_DIV
CONFIG_SYSCLK_PBA_DIV
CONFIG_SYSCLK_PBB_DIV
CONFIG_SYSCLK_PBC_DIV
CONFIG_SYSCLK_PBD_DIV
SYSCLK_SRC_OSC0
0
0
0
0
0
// ===== Disable all non-essential peripheral clocks
//#define CONFIG_SYSCLK_INIT_CPUMASK 0
//#define CONFIG_SYSCLK_INIT_PBAMASK SYSCLK_USART1
//#define CONFIG_SYSCLK_INIT_PBBMASK 0
//#define CONFIG_SYSCLK_INIT_PBCMASK 0
//#define CONFIG_SYSCLK_INIT_PBDMASK 0
//#define CONFIG_SYSCLK_INIT_HSBMASK 0
// ===== PLL Options
#define CONFIG_PLL0_SOURCE
PLL_SRC_OSC0
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
19
//#define CONFIG_PLL0_SOURCE
PLL_SRC_GCLK9
/* Fpll0 = (Fclk * PLL_mul) / PLL_div */
#define CONFIG_PLL0_MUL
#define CONFIG_PLL0_DIV
(48000000UL / BOARD_OSC0_HZ)
1
//#define CONFIG_PLL0_MUL
PLL_mul) / PLL_div */
//#define CONFIG_PLL0_DIV
(192000000 / FOSC0) /* Fpll = (Fclk *
4 /* Fpll = (Fclk * PLL_mul) / PLL_div */
// ==== DFLL Options
//#define CONFIG_DFLL0_SOURCE
//#define CONFIG_DFLL0_SOURCE
//#define CONFIG_DFLL0_SOURCE
//#define CONFIG_DFLL0_SOURCE
//#define CONFIG_DFLL0_SOURCE
GENCLK_SRC_OSC0
GENCLK_SRC_RCSYS
GENCLK_SRC_OSC32K
GENCLK_SRC_RC120M
GENCLK_SRC_RC32K
/* Fdfll = (Fclk * DFLL_mul) / DFLL_div */
//#define CONFIG_DFLL0_FREQ
48000000UL
//#define CONFIG_DFLL0_MUL
((4 * CONFIG_DFLL0_FREQ) / BOARD_OSC32_HZ)
//#define CONFIG_DFLL0_DIV
4
//#define CONFIG_DFLL0_MUL
(CONFIG_DFLL0_FREQ / BOARD_OSC32_HZ)
//#define CONFIG_DFLL0_DIV
1
// ===== USB Clock Source Options
#define CONFIG_USBCLK_SOURCE
//#define CONFIG_USBCLK_SOURCE
USBCLK_SRC_PLL0
USBCLK_SRC_DFLL
/* Fusb = Fsys / USB_div */
#define CONFIG_USBCLK_DIV
1
// ===== GCLK9 option
//#define CONFIG_GCLK9_SOURCE
//#define CONFIG_GCLK9_DIV
GENCLK_SRC_GCLKIN0
1
#endif /* CONF_CLOCK_H_INCLUDED */
4.3.
conf_clocks.h
4.3.1.
SAM D21 Devices (USB)
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel
Support</a>
*/
#include <clock.h>
#ifndef CONF_CLOCKS_H_INCLUDED
# define CONF_CLOCKS_H_INCLUDED
/* System clock bus configuration */
#
#
#
#
#
#
define
define
define
define
define
define
CONF_CLOCK_CPU_CLOCK_FAILURE_DETECT
CONF_CLOCK_FLASH_WAIT_STATES
CONF_CLOCK_CPU_DIVIDER
CONF_CLOCK_APBA_DIVIDER
CONF_CLOCK_APBB_DIVIDER
CONF_CLOCK_APBC_DIVIDER
false
2
SYSTEM_MAIN_CLOCK_DIV_1
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
SYSTEM_OSC8M_DIV_1
true
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
20
#
define CONF_CLOCK_OSC8M_RUN_IN_STANDBY
true
/* 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
true
# 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
false
# define CONF_CLOCK_XOSC32K_RUN_IN_STANDBY
true
/* 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
false
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_CLOSED
# 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 / 8)
(0xff / 8)
/* SYSTEM_CLOCK_SOURCE_DPLL configuration - Digital Phase-Locked Loop */
#
#
#
#
#
#
define
define
define
define
define
define
CONF_CLOCK_DPLL_ENABLE
CONF_CLOCK_DPLL_ON_DEMAND
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
true
false
false
true
# define CONF_CLOCK_DPLL_LOCK_TIME
SYSTEM_CLOCK_SOURCE_DPLL_LOCK_TIME_DEFAULT
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
21
# 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
/* 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
true
true
true
SYSTEM_CLOCK_SOURCE_DFLL
1
false
true
false
1
false
false
false
32
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
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
22
/* 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
#endif /* CONF_CLOCKS_H_INCLUDED */
4.4.
conf_board.h
4.4.1.
SAM3X and SAM3A Devices (UOTGHS: USB OTG High Speed)
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel
Support</a>
*/
#ifndef CONF_BOARD_H_INCLUDED
#define CONF_BOARD_H_INCLUDED
/* Pins description corresponding to Rxd,Txd, (UART pins) */
//#define CONSOLE_PINS
{PINS_UART}
/* Usart Hw ID used by the console (UART0) */
//#define CONSOLE_UART_ID
ID_UART
/* Configure UART pins */
//#define CONF_BOARD_UART_CONSOLE
/* Configure ADC example pins */
//#define CONF_BOARD_ADC
/* Configure PWM LED0 pin */
//#define CONF_BOARD_PWM_LED0
/* Configure PWM LED1 pin */
//#define CONF_BOARD_PWM_LED1
/* Configure PWM LED2 pin */
//#define CONF_BOARD_PWM_LED2
/* Configure SPI0 pins */
//#define CONF_BOARD_SPI0
//#define CONF_BOARD_SPI0_NPCS0
//#define CONF_BOARD_SPI0_NPCS1
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
23
//#define CONF_BOARD_SPI0_NPCS2
//#define CONF_BOARD_SPI0_NPCS3
/* Configure SPI1 pins */
//#define CONF_BOARD_SPI1
//#define CONF_BOARD_SPI1_NPCS0
//#define CONF_BOARD_SPI1_NPCS1
//#define CONF_BOARD_SPI1_NPCS2
//#define CONF_BOARD_SPI1_NPCS3
//#define CONF_BOARD_TWI0
//#define CONF_BOARD_TWI1
/* Configure USART RXD pin */
//#define CONF_BOARD_USART_RXD
/* Configure USART TXD pin */
//#define CONF_BOARD_USART_TXD
/* Configure USART CTS pin */
//#define CONF_BOARD_USART_CTS
/* Configure USART RTS pin */
//#define CONF_BOARD_USART_RTS
/* Configure USART synchronous communication SCK pin */
//#define CONF_BOARD_USART_SCK
/* Configure ADM3312 enable pin */
//#define CONF_BOARD_ADM3312_EN
/* Configure IrDA transceiver shutdown pin */
//#define CONF_BOARD_TFDU4300_SD
/* Configure RS485 transceiver ADM3485 RE pin */
//#define CONF_BOARD_ADM3485_RE
//#define CONF_BOARD_SMC_PSRAM
/* Configure LCD EBI pins */
//#define CONF_BOARD_HX8347A
/* Configure Backlight control pin */
//#define CONF_BOARD_AAT3194
/* Configure USB pins */
#define CONF_BOARD_USB_PORT
#endif /* CONF_BOARD_H_INCLUDED */
4.4.2.
SAM4L Device (USBC)
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel
Support</a>
*/
#ifndef CONF_BOARD_H_INCLUDED
#define CONF_BOARD_H_INCLUDED
/* Auto-initialize USART GPIOs when board_init() is called */
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
24
//#define CONF_BOARD_COM_PORT
/* Enable USB interface (USB) */
#define CONF_BOARD_USB_PORT
/* ID detect enabled,
uncomment it if jumper PB05/USB set */
#define CONF_BOARD_USB_ID_DETECT
/* Host VBUS control enabled,
uncomment it if jumper PC08/USB set */
/* Host VBUS control enabled,
uncomment it if jumper PC08/USB set */
#define CONF_BOARD_USB_VBUS_CONTROL
#define CONF_BOARD_USB_VBUS_ERR_DETECT
/* Enable USART to control Board Monitoring */
//#define CONF_BOARD_BM_USART
/* Initialize the LCD Backlight */
#define CONF_BOARD_BL
#endif /* CONF_BOARD_H_INCLUDED */
4.4.3.
SAM D21 Devices (USB)
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel
Support</a>
*/
#ifndef CONF_BOARD_H_INCLUDED
#define CONF_BOARD_H_INCLUDED
/* Enable USB VBUS detect */
#define CONF_BOARD_USB_VBUS_DETECT
/* ID detect enabled */
#define CONF_BOARD_USB_ID_DETECT
#endif /* CONF_BOARD_H_INCLUDED */
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
25
5.
USB Host Basic Setup
5.1.
USB Host User Configuration
The following USB host configuration must be included in the conf_usb_host.h file of the application:
1. USB_HOST_UHI (List of UHI APIs).
Define the list of UHI supported by USB host. (E.g.: UHI_MSC, UHI_HID_MOUSE).
2. USB_HOST_POWER_MAX (mA).
Maximum current allowed on Vbus.
3. USB_HOST_HS_SUPPORT (Only defined).
Authorize the USB host to run in High Speed.
4. USB_HOST_HUB_SUPPORT (Only defined).
Authorize the USB HUB support.
5.2.
USB Host User Callback
The following optional USB host callback can be defined in the conf_usb_host.h file of the application:
1. void UHC_MODE_CHANGE (bool b_host_mode).
To notify that the USB mode are switched automatically. This is possible only when ID pin is available.
2. void UHC_VBUS_CHANGE (bool b_present).
To notify that the Vbus level has changed (Available only in USB hardware with Vbus monitoring).
3. void UHC_VBUS_ERROR (void).
To notify that a Vbus error has occurred (Available only in USB hardware with Vbus monitoring).
4. void UHC_CONNECTION_EVENT (uhc_device_t* dev, bool b_present).
To notify that a device has been connected or disconnected.
5. void UHC_WAKEUP_EVENT (void).
Called when a USB device or the host have wake up the USB line.
6. void UHC_SOF_EVENT (void).
Called for each received SOF each 1ms. Available in High and Full speed mode.
7. uint8_t UHC_DEVICE_CONF (uhc_device_t* dev).
Called when a USB device configuration must be chosen. Thus, the application can choose either a
configuration number for this device or a configuration number 0 to reject it. If callback not defined the
configuration 1 is chosen.
8. void UHC_ENUM_EVENT (uhc_device_t* dev, uint8_t b_status).
Called when a USB device enumeration is completed or failed.
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
26
5.3.
USB Host Setup Steps
5.3.1.
USB Host Controller (UHC) - Prerequisites
Common prerequisites for all USB hosts.
®
This module is based on USB host 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 setup the project correctly:
•
Specify the clock configuration:
•
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 must use a
DFLL and an external OSC.
•
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 Host Controller (UHC) - Example Code
Common example code for all USB hosts.
Content of conf_usb_host.h:
#define USB_HOST_POWER_MAX
500
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
27
Add to application C-file:
void usb_init(void)
{
}
5.3.3.
uhc_start();
USB Device Controller (UHC) - Workflow
Common workflow for all USB devices.
1.
Ensure that conf_usb_host.h is available and contains the following configuration which is the main
USB device configuration:
// Maximum current allowed on Vbus (mA) which depends of 5V generator
#define USB_HOST_POWER_MAX
2.
500 // (500mA)
Call the USB host stack start function to enable USB Host stack:
uhc_start();
5.4.
conf_clock.h Examples
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)
Content of conf_clock.h for AT32UC3C device (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 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):
// USB Clock Source fixed at DFLL.
// SYSTEM_CLOCK_SOURCE_XOSC32K configuration - External 32KHz crystal/clock
oscillator
#
define CONF_CLOCK_XOSC32K_ENABLE
true
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
28
# 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
false
# define CONF_CLOCK_XOSC32K_RUN_IN_STANDBY
true
// 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_CLOSED
# define CONF_CLOCK_DFLL_ON_DEMAND
// 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
#
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
true
true
GCLK_GENERATOR_1
(48000000/32768)
true
true
true
true
(0x1f / 8)
(0xff / 8)
true
true
true
SYSTEM_CLOCK_SOURCE_DFLL
1
false
true
false
1
true
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
29
6.
Document Revision History
Doc. Rev.
Date
Comments
42346B
12/2015
Fixed typos
42346A
12/2014
Initial release
Atmel AT09341: USB Host Interface (UHI) for Vendor Class Device [APPLICATION NOTE]
Atmel-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
30
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-42346B-USB-Host-Interface-UHI-for-Vendor-Class-Device_AT09341_Application Note-12/2015
®
®
®
Atmel , Atmel logo and combinations thereof, Enabling Unlimited Possibilities , AVR , 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.