SAMV71 Xplained Ultra Software Package 1.5

ui.h File Reference

Common User Interface for USB host MSC application. More...

#include "USBH.h"

Go to the source code of this file.

Functions

void ui_init (void)
 Initializes the user interface.
void ui_usb_mode_change (bool b_host_mode)
 Notify that the USB mode are switched automatically. This is possible only when ID pin is available.
void ui_usb_vbus_change (bool b_vbus_present)
 Notify that a Vbus are changed Available only in USB hardware with Vbus monitoring.
void ui_usb_vbus_error (void)
 Notify that a Vbus error has occurred Available only in USB hardware with Vbus monitoring.
void ui_usb_connection_event (USBH_device_t *dev, bool b_present)
 Notify that a USB device has been connected or disconnected.
void ui_usb_wakeup_event (void)
 Notify that a USB device or the host has wake up the USB line.
void ui_usb_sof_event (void)
 Notify that a SOF has been sent (each 1 ms).
void ui_test_flag_reset (void)
 Resets the status flag of the test.
void ui_test_finish (bool b_success)
 Displays the result of the test.
void ui_usb_enum_event (USBH_device_t *dev, USBH_enum_status_t status)
 Notify the end of a USB device enumeration.
void ui_uhi_hid_mouse_change (USBH_device_t *dev, bool b_plug)
 Notify that a USB device HID has been connected or disconnected.
void ui_uhi_msc_change (USBH_device_t *dev, bool b_plug)
 Notify that a USB device MSC has been connected or disconnected.
Callback to manage the HID mouse events

void ui_uhi_hid_mouse_btn_left (bool b_state)
void ui_uhi_hid_mouse_btn_right (bool b_state)
void ui_uhi_hid_mouse_btn_middle (bool b_state)
void ui_uhi_hid_mouse_move (int8_t x, int8_t y, int8_t scroll)

Detailed Description

Common User Interface for USB host MSC application.

Definition in file ui.h.


Function Documentation

void ui_test_finish ( bool  b_success  ) 

Displays the result of the test.

Parameters:
b_success true, if the test is successfull

Definition at line 205 of file ui.c.

Here is the call graph for this function:

void ui_uhi_hid_mouse_change ( USBH_device_t dev,
bool  b_plug 
)

Notify that a USB device HID has been connected or disconnected.

Parameters:
dev Pointer on USB device information
b_plug true, if the device has been connected

Definition at line 148 of file ui.c.

void ui_uhi_msc_change ( USBH_device_t dev,
bool  b_plug 
)

Notify that a USB device MSC has been connected or disconnected.

Parameters:
dev Pointer on USB device information
b_plug true, if the device has been connected

Definition at line 154 of file ui.c.

void ui_usb_connection_event ( USBH_device_t dev,
bool  b_present 
)

Notify that a USB device has been connected or disconnected.

Parameters:
dev Pointer on USB device information
b_present true, if the device has been connected

Definition at line 88 of file ui.c.

Here is the call graph for this function:

void ui_usb_enum_event ( USBH_device_t dev,
USBH_enum_status_t  status 
)

Notify the end of a USB device enumeration.

Parameters:
dev Pointer on USB device information
status Status of the USB enumeration

Definition at line 100 of file ui.c.

Here is the call graph for this function:

void ui_usb_mode_change ( bool  b_host_mode  ) 

Notify that the USB mode are switched automatically. This is possible only when ID pin is available.

Parameters:
b_host_mode true, if the host mode has been selected

Notify that the USB mode are switched automatically. This is possible only when ID pin is available.

Parameters:
b_host_mode true, if the host mode has been selected

Definition at line 58 of file ui.c.

void ui_usb_vbus_change ( bool  b_vbus_present  ) 

Notify that a Vbus are changed Available only in USB hardware with Vbus monitoring.

Parameters:
b_vbus_present true, if Vbus is high.

Notify that a Vbus are changed Available only in USB hardware with Vbus monitoring.

Parameters:
b_vbus_present true, if Vbus is high.

Definition at line 75 of file ui.c.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines