sdio_probe.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __HAL_DRIVER_SDIO_PROBE_H__
#define __HAL_DRIVER_SDIO_PROBE_H__
 
/*============================ INCLUDES ======================================*/
 
#include "hal/vsf_hal_cfg.h"
 
#if VSF_HAL_USE_SDIO == ENABLED
 
#undef __VSF_SDIO_PROBE_PUBLIC_CONST__
#if     defined(__VSF_SDIO_PROBE_CLASS_IMPLEMENT)
#   undef __VSF_SDIO_PROBE_CLASS_IMPLEMENT
#   define __VSF_CLASS_IMPLEMENT__
#   define __VSF_SDIO_PROBE_PUBLIC_CONST__
#else
#   define __VSF_SDIO_PROBE_PUBLIC_CONST__              const
#endif
 
#include "utilities/ooc_class.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
vsf_class(vsf_sdio_probe_t) {
    public_member(
        uint32_t                    voltage;
        uint32_t                    working_clock_hz;
        uint8_t                     bus_width;
        bool                        uhs_en;
 
        __VSF_SDIO_PROBE_PUBLIC_CONST__ bool           high_capacity;
        __VSF_SDIO_PROBE_PUBLIC_CONST__ uint8_t        delay_ms;
        __VSF_SDIO_PROBE_PUBLIC_CONST__ uint32_t       version;
        __VSF_SDIO_PROBE_PUBLIC_CONST__ uint32_t       ocr;
        __VSF_SDIO_PROBE_PUBLIC_CONST__ uint64_t       capacity;
        __VSF_SDIO_PROBE_PUBLIC_CONST__ vsf_sdio_csd_t csd;
        __VSF_SDIO_PROBE_PUBLIC_CONST__ vsf_sdio_cid_t cid;
    )
    private_member(
        uint8_t                     state;
        uint8_t                     is_app_cmd : 1;
        uint8_t                     is_resp_r1 : 1;
        uint8_t                     is_to_retry : 1;
        uint8_t                     is_to_ignore_fail : 1;
        uint32_t                    rca;
        uint32_t                    r1_expected_card_status_mask;
        uint32_t                    r1_expected_card_status;
    )
};
 
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ LOCAL VARIABLES ===============================*/
/*============================ PROTOTYPES ====================================*/
 
extern vsf_err_t vsf_sdio_probe_start(vsf_sdio_t *sdio, vsf_sdio_probe_t *probe);
 
extern vsf_err_t vsf_sdio_probe_irqhandler(vsf_sdio_t *sdio, vsf_sdio_probe_t *probe,
        vsf_sdio_irq_mask_t irq_mask, vsf_sdio_reqsts_t status,
        uint32_t resp[4]);
 
#ifdef __cplusplus
}
#endif
 
#endif /* VSF_HAL_USE_SDIO */
#endif /* __HAL_DRIVER_SDIO_PROBE_H__ */