ASF4 API

1 Advanced Software Framework Version 4 (ASF4) Introduction and Context
This chapter starts with an overview of the features and objectives of ASF4. The context in the larger SW/Tools ecosystem is defined, giving a relation between the ASF4, START, and the IDE. A high-level work-flow overview is presented and documentation resources are described, to give insight into which references to use for what.
2 Software Architecture
3 Driver Implementation and Design Conventions
4 AC Drivers
5 ADC Drivers
6 Analog Glue Function
7 Audio Driver
8 CAN Driver
9 CRC Driver
10 Calendar Drivers
11 Camera Driver
12 Cryptography (AES) Driver
13 DAC Drivers
14 Delay Driver
15 Digital Glue Logic
16 Ethernet MAC Driver
17 Event System Driver
18 External Bus Driver
19 External IRQ Driver
20 Flash Driver
21 Frequency Meter Drivers
22 Graphic LCD Driver
23 Graphics Processing Unit Driver(2D)
24 Hash Algorithm Driver
25 Helper Drivers
26 I2C Drivers
27 I2S Controller Driver
28 MCI Drivers
29 PAC Driver
30 PWM Driver
31 Position Decoder Driver
32 Quad SPI Drivers
33 RAND Driver
34 SPI Drivers
35 Segment LCD Drivers
36 Temperature Sensor Drivers
37 Timer Driver
38 USART Drivers
39 USB Drivers
- 39.1 USB Device Driver
- 39.2 USB Host Driver
  - 39.2.1 Functions
    - 39.2.1.1 usb_h_init
      USB HCD Initialization.
    - 39.2.1.2 usb_h_deinit
      USB HCD de-initialization.
    - 39.2.1.3 usb_h_enable
      USB HCD enable.
    - 39.2.1.4 usb_h_disable
      USB HCD disable.
    - 39.2.1.5 usb_h_register_callback
      Register callbacks for USB HCD.
    - 39.2.1.6 usb_h_get_frame_n
      Return current frame number.
    - 39.2.1.7 usb_h_get_microframe_n
      Return current micro frame number.
    - 39.2.1.8 usb_h_suspend
      Suspend the USB bus.
    - 39.2.1.9 usb_h_resume
      Resume the USB bus.
    - 39.2.1.10 usb_h_rh_reset
      Reset the root hub port.
    - 39.2.1.11 usb_h_rh_suspend
      Suspend the root hub port.
    - 39.2.1.12 usb_h_rh_resume
      Resume the root hub port.
    - 39.2.1.13 usb_h_rh_check_status
      Root hub or port feature status check.
    - 39.2.1.14 usb_h_pipe_allocate
      Allocate a pipe for the USB host communication.
    - 39.2.1.15 usb_h_pipe_free
      Free an allocated pipe.
    - 39.2.1.16 usb_h_pipe_set_control_param
      Modify parameters of an allocated control pipe.
    - 39.2.1.17 usb_h_pipe_register_callback
      Register transfer callback on a pipe.
    - 39.2.1.18 usb_h_control_xfer
      Issue a control transfer (request) on a pipe.
    - 39.2.1.19 usb_h_bulk_int_iso_xfer
      Issue a bulk/interrupt/iso transfer on a pipe.
    - 39.2.1.20 usb_h_high_bw_out
      Issue a periodic high bandwidth output on a pipe.
    - 39.2.1.21 usb_h_pipe_is_busy
      Check if the pipe is busy transferring.
    - 39.2.1.22 usb_h_pipe_abort
      Abort pending transfer on a pipe.
    - 39.2.1.23 usb_h_get_version
      Return version of the driver.
40 Utility Drivers
41 WDT Driver
42 Revision History
The Microchip Web Site
Customer Change Notification Service
Customer Support
Microchip Devices Code Protection Feature
Legal Notice
Trademarks
Quality Management System Certified by DNV
Worldwide Sales and Service

39.2.1.18 usb_h_control_xfer

Issue a control transfer (request) on a pipe.

static int32_t usb_h_control_xfer(
    struct usb_h_pipe * pipe,
    uint8_t * setup,
    uint8_t * data,
    uint16_t length,
    int16_t timeout
)

Parameters

pipe

Type: struct usb_h_pipe *

The pipe

setup

Type: uint8_t *

Pointer to the setup packet

data

Type: uint8_t *

Pointer to the data buffer

length

Type: uint16_t

The data length

timeout

Type: int16_t

Timeout for whole request in ms

Returns

Type: int32_t

Operation result status

ERR_NOT_INITIALIZED: Pipe is not allocated
ERR_BUSY: Pipe is busy transferring
ERR_INVALID_ARG: Argument error
ERR_UNSUPPORTED_OP: Pipe is not control pipe
ERR_NONE: Operation done successfully