usbh_diskio.c File Reference

USB Host Disk I/O driver. More...

#include "ff_gen_drv.h"
#include "usbh_diskio.h"

Macros
#define	USB_DEFAULT_BLOCK_SIZE   512

Functions
DSTATUS	USBH_initialize (BYTE lun)
	Initializes a Drive. More...
DSTATUS	USBH_status (BYTE lun)
	Gets Disk Status. More...
DRESULT	USBH_read (BYTE lun, BYTE *buff, DWORD sector, UINT count)
	Reads Sector(s) More...

Variables
USBH_HandleTypeDef	hUSB_Host
const Diskio_drvTypeDef	USBH_Driver

Detailed Description

USB Host Disk I/O driver.

(based on usbh_diskio_template.c v2.0.2) This notice applies to any and all portions of this file that are not between comment pairs USER CODE BEGIN and USER CODE END. Other portions of this file, whether inserted by the user or by software development tools are owned by their respective copyright owners.

Copyright (c) 2019 STMicroelectronics International N.V. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted, provided that the following conditions are met:

1. Redistribution of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of STMicroelectronics nor the names of other contributors to this software may be used to endorse or promote products derived from this software without specific written permission.
4. This software, including modifications and/or derivative works of this software, must execute solely and exclusively on microcontroller or microprocessor devices manufactured by or for STMicroelectronics.
5. Redistribution and use of this software other than as permitted under this license is void and will automatically terminate your rights under this license.

THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

USB_DEFAULT_BLOCK_SIZE

#define USB_DEFAULT_BLOCK_SIZE   512

Function Documentation

USBH_initialize()

DSTATUS USBH_initialize

(

BYTE

lun

)

Initializes a Drive.

Parameters

lun

: lun id

Return values

DSTATUS

Operation status

                                  {
    /* CAUTION : USB Host library has to be initialized in the application */
 
    return RES_OK;
}

USBH_status()

DSTATUS USBH_status

(

BYTE

lun

)

Gets Disk Status.

Parameters

lun

: lun id

Return values

DSTATUS

Operation status

                              {
    DRESULT res = RES_ERROR;
 
    if (USBH_MSC_UnitIsReady(&hUSB_Host, lun)) {
        res = RES_OK;
    } else {
        res = RES_ERROR;
    }
 
    return res;
}

Here is the call graph for this function:

USBH_read()

DRESULT USBH_read	(	BYTE	lun,
		BYTE *	buff,
		DWORD	sector,
		UINT	count
	)

Reads Sector(s)

Parameters

lun	: lun id
*buff	Data buffer to store read data
sector	Sector address (LBA)
count	Number of sectors to read (1..128)

Return values

DRESULT

Operation result

                                                                  {
    DRESULT res = RES_ERROR;
    MSC_LUNTypeDef info;
 
    if (USBH_MSC_Read(&hUSB_Host, lun, sector, buff, count) == USBH_OK) {
        res = RES_OK;
    } else {
        USBH_MSC_GetLUNInfo(&hUSB_Host, lun, &info);
 
        switch (info.sense.asc) {
        case SCSI_ASC_LOGICAL_UNIT_NOT_READY:
        case SCSI_ASC_MEDIUM_NOT_PRESENT:
        case SCSI_ASC_NOT_READY_TO_READY_CHANGE:
            USBH_ErrLog("USB Disk is not ready!");
            res = RES_NOTRDY;
            break;
 
        default:
            res = RES_ERROR;
            break;
        }
    }
 
    return res;
}

Here is the call graph for this function:

Variable Documentation

hUSB_Host

USBH_HandleTypeDef hUSB_Host

USBH_Driver

const Diskio_drvTypeDef USBH_Driver

Initial value:

= {
    USBH_initialize,
    USBH_status,
    USBH_read,
 
 
 
 
 
 
}