SDSPI.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_SDSPI__include
#define ti_drivers_SDSPI__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#define SDSPI_CMD_RESERVED           32

#define SDSPI_STATUS_RESERVED       -32

#define SDSPI_STATUS_SUCCESS        0

#define SDSPI_STATUS_ERROR         -1

#define SDSPI_STATUS_UNDEFINEDCMD  -2

typedef struct SDSPI_Config      *SDSPI_Handle;


typedef struct SDSPI_Params {
    uint32_t bitRate; 
    void    *custom;  
} SDSPI_Params;

typedef void        (*SDSPI_InitFxn)     (SDSPI_Handle handle);

typedef SDSPI_Handle (*SDSPI_OpenFxn)   (SDSPI_Handle handle,
                                         unsigned char drv,
                                         SDSPI_Params *params);

typedef void        (*SDSPI_CloseFxn)    (SDSPI_Handle handle);

typedef int         (*SDSPI_ControlFxn)  (SDSPI_Handle handle,
                                          unsigned int cmd,
                                          void *arg);

typedef struct SDSPI_FxnTable {
    SDSPI_InitFxn         initFxn;

    SDSPI_OpenFxn         openFxn;

    SDSPI_CloseFxn        closeFxn;

    SDSPI_ControlFxn      controlFxn;
} SDSPI_FxnTable;

typedef struct SDSPI_Config {
    SDSPI_FxnTable const *fxnTablePtr;

    void                 *object;

    void           const *hwAttrs;
} SDSPI_Config;

extern void SDSPI_close(SDSPI_Handle handle);

extern int SDSPI_control(SDSPI_Handle handle, unsigned int cmd, void *arg);

extern void SDSPI_init(void);

extern SDSPI_Handle SDSPI_open(unsigned int index, unsigned char drv,
                               SDSPI_Params *params);

extern void SDSPI_Params_init(SDSPI_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_SDSPI__include */