USBMSCHFatFs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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.
 */
#ifndef ti_drivers_USBMSCHFATFS__include
#define ti_drivers_USBMSCHFATFS__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>

#define USBMSCHFatFs_CMD_RESERVED                32

#define USBMSCHFatFs_STATUS_RESERVED            -32

#define USBMSCHFatFs_STATUS_SUCCESS             0

#define USBMSCHFatFs_STATUS_ERROR              -1

#define USBMSCHFatFs_STATUS_UNDEFINEDCMD       -2

/* Add USBMSCHFatFs_CMD_<commands> here */

typedef struct USBMSCHFatFs_Config *USBMSCHFatFs_Handle;

typedef struct USBMSCHFatFs_Params {
    unsigned int servicePriority;      
    void        *serviceTaskStackPtr;  
    size_t       serviceTaskStackSize; 
    uintptr_t    custom;               
} USBMSCHFatFs_Params;

typedef void (*USBMSCHFatFs_InitFxn) (USBMSCHFatFs_Handle handle);

typedef USBMSCHFatFs_Handle (*USBMSCHFatFs_OpenFxn) (USBMSCHFatFs_Handle handle,
                                                     unsigned char drv,
                                                     USBMSCHFatFs_Params *params);

typedef void (*USBMSCHFatFs_CloseFxn) (USBMSCHFatFs_Handle handle);

typedef int  (*USBMSCHFatFs_ControlFxn) (USBMSCHFatFs_Handle handle,
                                         unsigned int cmd,
                                         void *arg);

typedef bool (*USBMSCHFatFs_waitForconnectFxn) (USBMSCHFatFs_Handle handle,
                                                unsigned int timeout);

typedef struct USBMSCHFatFs_FxnTable {
    USBMSCHFatFs_InitFxn         initFxn;

    USBMSCHFatFs_OpenFxn         openFxn;

    USBMSCHFatFs_CloseFxn        closeFxn;

    USBMSCHFatFs_ControlFxn      controlFxn;

    USBMSCHFatFs_waitForconnectFxn waitForConnectFxn;
} USBMSCHFatFs_FxnTable;

typedef struct USBMSCHFatFs_Config {
    USBMSCHFatFs_FxnTable const *fxnTablePtr;

    void                        *object;

    void const                  *hwAttrs;
} USBMSCHFatFs_Config;

extern void USBMSCHFatFs_close(USBMSCHFatFs_Handle handle);

extern int USBMSCHFatFs_control(USBMSCHFatFs_Handle handle,
                                unsigned int cmd,
                                void *arg);

extern void USBMSCHFatFs_init(void);

extern USBMSCHFatFs_Handle USBMSCHFatFs_open(unsigned int index,
                                             unsigned char drv,
                                             USBMSCHFatFs_Params *params);

extern void USBMSCHFatFs_Params_init(USBMSCHFatFs_Params *params);

extern bool USBMSCHFatFs_waitForConnect(USBMSCHFatFs_Handle handle,
                                        unsigned int timeout);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_USBMSCHFATFS__include */