External API Headers

Headers for interfaces that are shared with code outside of the SDK

boot_picobin_headers

Constants for PICOBIN format.

boot_picoboot_headers

Header file for the PICOBOOT USB interface exposed by an RP2xxx chip in BOOTSEL mode.

boot_uf2_headers

Header file for the UF2 format supported by a RP2xxx chip in BOOTSEL mode.

pico_usb_reset_interface_headers

Definition for the reset interface that may be exposed by the pico_stdio_usb library.

boot_picobin_headers

Constants for PICOBIN format.

boot_picoboot_headers

Header file for the PICOBOOT USB interface exposed by an RP2xxx chip in BOOTSEL mode.

Enumerations

enum picoboot_exclusive_type { NOT_EXCLUSIVE = 0, EXCLUSIVE, EXCLUSIVE_AND_EJECT }

Exclusivity level for a PC_EXCLUSIVE_ACCESS command.

Functions

struct __packed __aligned (4) picoboot_cmd

A PICOBOOT command packet sent to the OUT endpoint.

Enumeration Type Documentation

picoboot_exclusive_type

enum picoboot_exclusive_type

Exclusivity level for a PC_EXCLUSIVE_ACCESS command.

Enumerator

NOT_EXCLUSIVE

No restriction on USB Mass Storage operation.

EXCLUSIVE

Disable USB Mass Storage writes (any active UF2 download will be aborted)

EXCLUSIVE_AND_EJECT

Lock out USB Mass Storage by marking the drive media as not present (eject the drive)

Function Documentation

__aligned

struct __packed __aligned (4)

A PICOBOOT command packet sent to the OUT endpoint.

Status response returned by the PICOBOOT_IF_CMD_STATUS control request.

A 32-byte packet written to the PICOBOOT OUT endpoint to initiate any supported command. After sending this packet, transfer_length bytes are exchanged via the IN or OUT endpoint as appropriate, followed by a zero-length ACK packet.

A 16-byte structure read back from the device to determine the outcome of the most recently issued command.

boot_uf2_headers

Header file for the UF2 format supported by a RP2xxx chip in BOOTSEL mode.

pico_usb_reset_interface_headers

Definition for the reset interface that may be exposed by the pico_stdio_usb library.