hal_sd.h

/* Copyright Statement:
 *
 * (C) 2005-2017 MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __HAL_SD_H__
#define __HAL_SD_H__

#include "hal_platform.h"

#ifdef HAL_SD_MODULE_ENABLED

#ifdef HAL_SD_CARD_DETECTION

#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    HAL_SD_STATUS_BUSY                       = -2,                        
    HAL_SD_STATUS_ERROR                      = -1,                        
    HAL_SD_STATUS_OK                         =  0,                        
} hal_sd_status_t;


typedef enum {
    HAL_SD_BUS_WIDTH_1 = 1,                                        
    HAL_SD_BUS_WIDTH_4 = 2                                         
} hal_sd_bus_width_t;


typedef enum {
    HAL_SD_TYPE_SD_CARD            = 0,                          
    HAL_SD_TYPE_MMC_CARD           = 1,                          
    HAL_SD_TYPE_SD20_LCS_CARD      = 2,                          
    HAL_SD_TYPE_SD20_HCS_CARD      = 3,                          
    HAL_SD_TYPE_MMC42_CARD         = 4,                          
    HAL_SD_TYPE_CARD_TYPE_MAX      = 5,
    HAL_SD_TYPE_UNKNOWN_CARD       = 0xff,                       
} hal_sd_card_type_t;

#ifdef HAL_SD_CARD_DETECTION

typedef enum {
    HAL_SD_EVENT_CARD_INSERTED = 0,           
    HAL_SD_EVENT_CARD_REMOVED = 1,            
} hal_sd_card_event_t;
#endif

typedef enum {
    HAL_SD_EVENT_SUCCESS = 0,                  
    HAL_SD_EVENT_TRANSFER_ERROR = -1,          
    HAL_SD_EVENT_CRC_ERROR = -2,               
    HAL_SD_EVENT_DATA_TIMEOUT = -3,            
}hal_sd_callback_event_t;

typedef struct {
    hal_sd_bus_width_t bus_width;                                  
    uint32_t           clock;                                      
} hal_sd_config_t;

#ifdef HAL_SD_CARD_DETECTION

typedef void (*hal_sd_card_detect_callback_t)(hal_sd_card_event_t event, void *user_data);
#endif

typedef void (*hal_sd_callback_t)(hal_sd_callback_event_t event, void *user_data);
hal_sd_status_t hal_sd_init(hal_sd_port_t sd_port, hal_sd_config_t *sd_config);


hal_sd_status_t hal_sd_deinit(hal_sd_port_t sd_port);

#ifdef HAL_SD_CARD_DETECTION

hal_sd_status_t hal_sd_register_card_detection_callback(hal_sd_port_t sd_port, hal_sd_callback_t sd_callback, void *user_data);
#endif

hal_sd_status_t hal_sd_set_bus_width(hal_sd_port_t sd_port, hal_sd_bus_width_t bus_width);


hal_sd_status_t hal_sd_set_clock(hal_sd_port_t sd_port, uint32_t clock);


hal_sd_status_t hal_sd_get_clock(hal_sd_port_t sd_port, uint32_t *clock);


hal_sd_status_t hal_sd_get_capacity(hal_sd_port_t sd_port, uint64_t *capacity);


hal_sd_status_t hal_sd_get_erase_sector_size(hal_sd_port_t sd_port, uint32_t *erase_sector_size);


hal_sd_status_t hal_sd_erase_sectors(hal_sd_port_t sd_port, uint32_t start_sector, uint32_t sector_number);


hal_sd_status_t hal_sd_read_blocks(hal_sd_port_t sd_port, uint32_t *read_buffer, uint32_t start_address, uint32_t block_number);


hal_sd_status_t hal_sd_write_blocks(hal_sd_port_t sd_port, const uint32_t *write_data, uint32_t start_address, uint32_t block_number);

hal_sd_status_t hal_sd_read_blocks_dma_blocking(hal_sd_port_t sd_port, uint32_t *read_buffer, uint32_t start_address, uint32_t block_number);


hal_sd_status_t hal_sd_write_blocks_dma_blocking(hal_sd_port_t sd_port, const uint32_t *write_data, uint32_t start_address, uint32_t block_number);


hal_sd_status_t hal_sd_get_csd(hal_sd_port_t sd_port, uint32_t *csd);


hal_sd_status_t hal_sd_get_cid(hal_sd_port_t sd_port, uint32_t *cid);


hal_sd_status_t hal_sd_get_card_type(hal_sd_port_t sd_port, hal_sd_card_type_t *card_type);


hal_sd_status_t hal_sd_get_ocr(hal_sd_port_t sd_port, uint32_t *ocr);


hal_sd_status_t hal_sd_get_card_status(hal_sd_port_t sd_port, uint32_t *card_status);

hal_sd_status_t hal_sd_register_callback(hal_sd_port_t sd_port, hal_sd_callback_t sd_callback,void *user_data);

hal_sd_status_t hal_sd_read_blocks_dma(hal_sd_port_t sd_port, uint32_t *read_buffer, uint32_t read_address, uint32_t block_number);

hal_sd_status_t hal_sd_write_blocks_dma(hal_sd_port_t sd_port, const uint32_t *write_buffer,  uint32_t write_address, uint32_t block_number);

#ifdef __cplusplus
}
#endif

#endif /*HAL_SD_MODULE_ENABLED*/
#endif /* __HAL_SD_H__ */