SDIO.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025, 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.
 */

/*!***************************************************************************
 *  @file       SDIO.h
 *  @brief      Secure Digital Input Output (SDIO) Driver
 *
 *  @anchor ti_drivers_SDIO_Overview
 *  # Overview
 *
 *  The SDIO driver is designed to serve as an interface to perform basic
 *  transfers directly between Hosts.
 *
 *  <hr>
 *  @anchor ti_drivers_SDIO_Usage
 *  # Usage
 *  SDIO (Secure Digital Input Output) provides a reliable and efficient method for
 *  connecting peripheral devices to a host system.
 *  It allows the host device, such as a microcontroller or processor, to communicate with various
 *  SDIO-compatible modules, including Wi-Fi, Bluetooth, GPS, and other external peripherals.
 *  The host can use standard SDIO commands to initialize and control the connected device.
 *
 *  @anchor ti_drivers_SDIO_Synopsis
 *  ## Synopsis
 *  @anchor ti_drivers_SDIO_Synopsis_Code
 *
 *  <hr>
 *  @anchor ti_drivers_SDIO_Configuration
 *  # Configuration
 *  Refer to the @ref driver_configuration "Driver's Configuration"
 *  section for driver configuration information.
 *
 *  <hr>
 ******************************************************************************
 */

#ifndef ti_drivers_SDIO__include
#define ti_drivers_SDIO__include

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#define SDIO_STATUS_SUCCESS (0)

#define SDIO_STATUS_ERROR (-1)

typedef struct SDIO_Config_ *SDIO_Handle;

/* SDIO Parameters */
typedef struct
{
    void *custom; 
} SDIO_Params;

typedef struct SDIO_Config_
{

    void *object;

    void const *hwAttrs;
} SDIO_Config;

extern void SDIO_close(SDIO_Handle handle);

extern void SDIO_init(void);

extern void SDIO_Params_init(SDIO_Params *params);

extern SDIO_Handle SDIO_open(uint_least8_t index, SDIO_Params *params);

extern int_fast16_t SDIO_read(SDIO_Handle handle, void *buf, int_fast32_t numByte);

extern int_fast16_t SDIO_write(SDIO_Handle handle, void *buf, int_fast32_t numByte);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_SDIO__include */