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.1.1 Structs
  - 39.1.2 Typedefs
  - 39.1.3 Functions
    - 39.1.3.1 usb_d_init
      Initialize the USB device driver.
    - 39.1.3.2 usb_d_deinit
      Deinitialize the USB device driver.
    - 39.1.3.3 usb_d_register_callback
      Register the USB device callback.
    - 39.1.3.4 usb_d_enable
      Enable the USB device driver.
    - 39.1.3.5 usb_d_disable
      Disable the USB device driver.
    - 39.1.3.6 usb_d_attach
      Attach the USB device.
    - 39.1.3.7 usb_d_detach
      Detach the USB device.
    - 39.1.3.8 usb_d_get_speed
      Retrieve current USB working speed.
    - 39.1.3.9 usb_d_get_frame_num
      Retrieve current USB frame number.
    - 39.1.3.10 usb_d_get_uframe_num
      Retrieve current USB micro frame number.
    - 39.1.3.11 usb_d_set_address
      Set the USB address that is used.
    - 39.1.3.12 usb_d_send_remotewakeup
      Send remote wakeup to host.
    - 39.1.3.13 usb_d_ep0_init
      Initialize the endpoint 0.
    - 39.1.3.14 usb_d_ep_init
      Initialize the endpoint.
    - 39.1.3.15 usb_d_ep_deinit
      Disable and deinitialize the endpoint.
    - 39.1.3.16 usb_d_ep_register_callback
      Register the USB device endpoint callback on initialized endpoint.
    - 39.1.3.17 usb_d_ep_enable
      Enabled the initialized endpoint.
    - 39.1.3.18 usb_d_ep_disable
      Disable the initialized endpoint.
    - 39.1.3.19 usb_d_ep_get_req
      Get request data pointer to access received setup request packet.
    - 39.1.3.20 usb_d_ep_transfer
      Endpoint transfer.
    - 39.1.3.21 usb_d_ep_abort
      Abort an on-going transfer on a specific endpoint.
    - 39.1.3.22 usb_d_ep_get_status
      Retrieve the endpoint status.
    - 39.1.3.23 usb_d_ep_halt
      Endpoint halt control.
    - 39.1.3.24 usb_d_get_version
      Retrieve the current driver version.
- 39.2 USB Host 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.1.3.23 usb_d_ep_halt

Endpoint halt control.

int32_t usb_d_ep_halt(
    const uint8_t ep,
    const enum usb_ep_halt_ctrl ctrl
)

Parameters

ep

Type: const uint8_t

The endpoint address.

ctrl

Type: const enum usb_ep_halt_ctrl

Control code (SET/CLEAR/GET).

Returns

Type: int32_t

Operation status or HALT state (if ctrl is USB_EP_HALT_GET).

The online versions of the documents are provided as a courtesy. Verify all content and data in the device’s PDF documentation found on the device product page.