usb_msd_host.h

/*
 * USB Mass Storage Device Host Driver for SOMRT1061
 *
 * Public API header file
 *
 * This driver enables reading/writing USB flash drives using NetBurner's
 * EFFS-FAT file system on the SOMRT1061 platform.
 */
 
#ifndef _USB_MSD_HOST_H_
#define _USB_MSD_HOST_H_
 
#include <nbrtos.h>
#include <effs_fat/fat.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Maximum number of MSD drives supported */
#define MAX_MSD_DRIVES 1
 
/* MSD status codes - matches MCF5441X pattern */
typedef enum {
    MSD_STAT_DEVICE_IDLE = 0,           /* No device connected */
    MSD_STAT_DEVICE_ATTACHED,           /* Device detected, enumerating */
    MSD_STAT_DEVICE_CONFIGURED,         /* USB configured */
    MSD_STAT_DEVICE_SET_INTERFACE,      /* Set interface in progress */
    MSD_STAT_DEVICE_INTERFACED,         /* Interface set complete */
    MSD_STAT_DEVICE_DETACHED,           /* Device removed */
    MSD_STAT_DEVICE_OTHER,              /* Other state */
    MSD_STAT_DEVICE_UNKNOWN,            /* Unknown state */
    MSD_STAT_VOLUME_INITIALIZED,        /* Ready for file operations */
    MSD_STAT_DEVICE_POST_QUERY,         /* Querying device */
    MSD_STAT_DRIVE_CHANGE_FAILED        /* Mount/init failed */
} MSD_STATES;
 
/*
 * Initialize USB Host MSD subsystem
 *
 * This function initializes the USB Host controller on USB2 (OTG2) port
 * and sets up the MSD class driver. It must be called before any other
 * MSD functions.
 *
 * Parameters:
 *   psema    - Pointer to semaphore that will be posted on device state changes
 *   iVolume  - Pointer to receive the assigned volume number
 *
 * Returns:
 *   0 on success, negative value on error
 */
int MSDOpen(OS_SEM *psema, int *iVolume);
 
/*
 * Get current device status
 *
 * Returns the current state of the MSD device connection.
 *
 * Returns:
 *   One of the MSD_STATES enum values
 */
int GetMSDStatus(void);
 
/*
 * Enable/disable 5V VBUS power
 *
 * Controls the VBUS power supply to the USB Host port.
 * Must be enabled for USB devices to be detected and powered.
 *
 * Parameters:
 *   enable - true to enable VBUS power, false to disable
 */
void VBUSEnable(bool enable);
 
/*
 * EFFS-FAT driver initialization function
 *
 * This function is passed to f_initvolume() to initialize the MSD
 * as a file system volume.
 *
 * Parameters:
 *   driver_param - Driver parameter (drive number, 0 to MAX_MSD_DRIVES-1)
 *
 * Returns:
 *   Pointer to F_DRIVER structure, or NULL on error
 */
F_DRIVER *msd_initfunc(unsigned long driver_param);
 
/*
 * Check if MSD device is ready for file operations
 *
 * Returns:
 *   true if device is ready, false otherwise
 */
bool IsMSDReady(void);
 
/*
 * Get the sector size of the connected MSD device
 *
 * Returns:
 *   Sector size in bytes (typically 512), or 0 if no device
 */
uint32_t GetMSDSectorSize(void);
 
/*
 * Get the total number of sectors on the connected MSD device
 *
 * Returns:
 *   Number of sectors, or 0 if no device
 */
uint32_t GetMSDSectorCount(void);
 
/*
 * Debug: Dump USB Host controller register status
 *
 * Prints USB2 controller registers, PHY status, and VBUS pin state
 * to help diagnose USB Host issues.
 */
void USB_HostDumpRegisters(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _USB_MSD_HOST_H_ */