usb.hpp

Go to the documentation of this file.

#ifndef SBL_USB_USB_HPP_
#define SBL_USB_USB_HPP_
 
/**
 * @file usb.hpp
 * @brief USB subsystem control
 *
 * Provides initialization and task processing for USB functionality.
 * The actual implementation is MCU-specific and lives in sbl-hardware.
 *
 * Usage:
 *   #include <sbl/usb/usb.hpp>
 *
 *   int main() {
 *       sbl::driver::init();
 *       sbl::usb::init();
 *
 *       while (true) {
 *           sbl::usb::task();  // Process USB events
 *           // ... application code ...
 *       }
 *   }
 */
 
#include <cstdint>
 
namespace sbl::usb {
 
/**
 * @brief Initialize USB subsystem
 *
 * Sets up USB peripheral clocks, pins, and initializes TinyUSB.
 * Call once at startup after sbl::driver::init().
 */
void init();
 
/**
 * @brief Process USB events
 *
 * Must be called periodically (from main loop or timer) to handle
 * USB enumeration, data transfer, and protocol handling.
 *
 * On RP2xxx: Can also be IRQ-driven, but task() still needs calling.
 * On STM32: Typically polled from main loop.
 */
void task();
 
/**
 * @brief Check if USB is enumerated and ready
 *
 * @return true if USB device is configured and ready for communication
 */
bool ready();
 
} // namespace sbl::usb
 
#endif // SBL_USB_USB_HPP_