MassStorageController Class Reference

#include <mass_storage_device.h>

Inheritance diagram for MassStorageController:

Collaboration diagram for MassStorageController:

Data Structures
struct	LunEntry

Public Member Functions
	MassStorageController (USBDriver *usb)
void	attachLun (uint8_t lunIndex, BaseBlockDevice *blkdev, uint8_t *blkbuf, size_t blkbufsize, const scsi_inquiry_response_t *inquiry, const scsi_unit_serial_number_inquiry_response_t *serialInquiry)
Public Member Functions inherited from ThreadController< USB_MSD_THREAD_WA_SIZE >
	ThreadController (const char *name, tprio_t priority)
void	start ()
	Start the thread.
void	stop ()
	Request thread termination and waits for termination.

Protected Member Functions
void	ThreadTask () override
Protected Member Functions inherited from ThreadController< USB_MSD_THREAD_WA_SIZE >
void	main () override

Private Member Functions
void	sendCsw (uint8_t status, uint32_t residue)

Static Private Member Functions
static bool	cbwValid (const msd_cbw_t &cbw, msg_t status)
static bool	cbwMeaningful (const msd_cbw_t &cbw)

Private Attributes
usbmsdstate_t	m_state
USBDriver *const	m_usb
msd_cbw_t	m_cbw
msd_csw_t	m_csw
SCSITransport	m_scsiTransport
usb_scsi_transport_handler_t	m_scsiTransportHandler
chibios_rt::Mutex	m_lunMutex
LunEntry	m_luns [USB_MSD_LUN_COUNT]

Additional Inherited Members
Protected Attributes inherited from ThreadController< USB_MSD_THREAD_WA_SIZE >
const char *const	m_name

Detailed Description

Definition at line 15 of file mass_storage_device.h.

Constructor & Destructor Documentation

MassStorageController()

MassStorageController::MassStorageController

(

USBDriver *

usb

)

Definition at line 76 of file mass_storage_device.cpp.

    : ThreadController("MSD", MSD_THD_PRIO)
    , m_usb(usb) {
    for (size_t i = 0; i < USB_MSD_LUN_COUNT; i++) {
        scsiObjectInit(&m_luns[i].target);
    }
 
    m_scsiTransportHandler.usbp = usb;
    m_scsiTransportHandler.ep = USB_MSD_DATA_EP;
    m_scsiTransport.handler  = &m_scsiTransportHandler;
    m_scsiTransport.transmit = scsi_transport_transmit;
    m_scsiTransport.transmit_start = scsi_transport_transmit_start;
    m_scsiTransport.transmit_wait = scsi_transport_transmit_wait;
    m_scsiTransport.receive  = scsi_transport_receive;
}

Here is the call graph for this function:

Member Function Documentation

attachLun()

void MassStorageController::attachLun	(	uint8_t	lunIndex,
		BaseBlockDevice *	blkdev,
		uint8_t *	blkbuf,
		size_t	blkbufsize,
		const scsi_inquiry_response_t *	inquiry,
		const scsi_unit_serial_number_inquiry_response_t *	serialInquiry
	)

Definition at line 182 of file mass_storage_device.cpp.

                                                                                         {
    chibios_rt::MutexLocker lock(m_lunMutex);
 
    auto& lun = m_luns[lunIndex];
 
 
    if (NULL == inquiry) {
        lun.config.inquiry_response = &default_scsi_inquiry_response;
    }
    else {
        lun.config.inquiry_response = inquiry;
    }
    if (NULL == serialInquiry) {
        lun.config.unit_serial_number_inquiry_response = &default_scsi_unit_serial_number_inquiry_response;
    }
    else {
        lun.config.unit_serial_number_inquiry_response = serialInquiry;
    }
    lun.config.blkbuf = blkbuf;
    lun.config.blkbufsize = blkbufsize;
    lun.config.blkdev = blkdev;
    lun.config.transport = &m_scsiTransport;
 
    scsiStart(&lun.target, &lun.config);
}

Referenced by attachMsdSdCard(), deattachMsdSdCard(), and initUsbMsd().

Here is the caller graph for this function:

cbwMeaningful()

bool MassStorageController::cbwMeaningful ( const msd_cbw_t &  cbw )

staticprivate

Definition at line 128 of file mass_storage_device.cpp.

                                                                {
    if ((cbw.cmd_len & CBW_CMD_LEN_RESERVED_MASK) != 0) {
        return false;
    }
 
    if ((cbw.flags & CBW_FLAGS_RESERVED_MASK) != 0) {
        return false;
    }
 
    if (cbw.lun >= USB_MSD_LUN_COUNT) {
        return false;
    }
 
    return true;
}

Referenced by ThreadTask().

Here is the caller graph for this function:

cbwValid()

bool MassStorageController::cbwValid ( const msd_cbw_t &  cbw, msg_t  status  )

staticprivate

Definition at line 114 of file mass_storage_device.cpp.

                                                                        {
    // check valid size
    if (sizeof(msd_cbw_t) != recvd) {
        return false;
    }
 
    // Check valid signature
    if (cbw.signature != MSD_CBW_SIGNATURE) {
        return false;
    }
 
    return true;
}

Referenced by ThreadTask().

Here is the caller graph for this function:

sendCsw()

void MassStorageController::sendCsw ( uint8_t  status, uint32_t  residue  )

private

Definition at line 144 of file mass_storage_device.cpp.

                                                                    {
    m_csw.signature = MSD_CSW_SIGNATURE;
    m_csw.data_residue = residue;
    m_csw.tag = m_cbw.tag;
    m_csw.status = status;
 
    usbTransmit(m_usb, USB_MSD_DATA_EP, (uint8_t*)&m_csw, sizeof(m_csw));
}

Referenced by ThreadTask().

Here is the caller graph for this function:

ThreadTask()

void MassStorageController::ThreadTask ( )

overrideprotectedvirtual

Implements ThreadController< USB_MSD_THREAD_WA_SIZE >.

Definition at line 92 of file mass_storage_device.cpp.

                                       {
    while (!chThdShouldTerminateX()) {
        const msg_t status = usbReceive(m_usb, USB_MSD_DATA_EP, (uint8_t*)&m_cbw, sizeof(m_cbw));
 
        if (MSG_RESET == status) {
            chThdSleepMilliseconds(50);
            continue;
        }
 
        if (cbwValid(m_cbw, status) && cbwMeaningful(m_cbw)) {
            auto target = &m_luns[m_cbw.lun].target;
            if (SCSI_SUCCESS == scsiExecCmd(target, m_cbw.cmd_data)) {
                sendCsw(CSW_STATUS_PASSED, 0);
            } else {
                sendCsw(CSW_STATUS_FAILED, scsiResidue(target));
            }
        } else {
            // ignore incorrect CBW
        }
    }
}

Here is the call graph for this function:

Field Documentation

m_cbw

msd_cbw_t MassStorageController::m_cbw

private

Definition at line 36 of file mass_storage_device.h.

Referenced by sendCsw(), and ThreadTask().

m_csw

msd_csw_t MassStorageController::m_csw

private

Definition at line 37 of file mass_storage_device.h.

Referenced by sendCsw().

m_lunMutex

chibios_rt::Mutex MassStorageController::m_lunMutex

private

Definition at line 42 of file mass_storage_device.h.

Referenced by attachLun().

m_luns

LunEntry MassStorageController::m_luns[USB_MSD_LUN_COUNT]

private

Definition at line 49 of file mass_storage_device.h.

Referenced by attachLun(), MassStorageController(), and ThreadTask().

m_scsiTransport

SCSITransport MassStorageController::m_scsiTransport

private

Definition at line 39 of file mass_storage_device.h.

Referenced by attachLun(), and MassStorageController().

m_scsiTransportHandler

usb_scsi_transport_handler_t MassStorageController::m_scsiTransportHandler

private

Definition at line 40 of file mass_storage_device.h.

Referenced by MassStorageController().

m_state

usbmsdstate_t MassStorageController::m_state

private

Definition at line 31 of file mass_storage_device.h.

m_usb

USBDriver* const MassStorageController::m_usb

private

Definition at line 33 of file mass_storage_device.h.

Referenced by sendCsw(), and ThreadTask().

---

The documentation for this class was generated from the following files:

• hw_layer/mass_storage/mass_storage_device.h
• hw_layer/mass_storage/mass_storage_device.cpp