hal_sdio.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_SDIO_H__
#define __HAL_SDIO_H__
#include "hal_platform.h"

#ifdef HAL_SDIO_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    HAL_SDIO_STATUS_BUSY                       = -2,                        
    HAL_SDIO_STATUS_ERROR                      = -1,                        
    HAL_SDIO_STATUS_OK                         =  0,                        
} hal_sdio_status_t;


typedef enum {
    HAL_SDIO_BUS_WIDTH_1 = 1,                                        
    HAL_SDIO_BUS_WIDTH_4 = 2                                         
} hal_sdio_bus_width_t;


typedef enum {
    HAL_SDIO_DIRECTION_READ  = 0,                                               
    HAL_SDIO_DIRECTION_WRITE = 1                                                
} hal_sdio_direction_t;


typedef enum {
    HAL_SDIO_FIXED_ADDRESS        = 0,                                           
    HAL_SDIO_INCREMENTING_ADDRESS = 1                                            
} hal_sdio_command53_operation_t;


typedef enum {
    HAL_SDIO_FUNCTION_0 = 0,                                              
    HAL_SDIO_FUNCTION_1 = 1                                               
} hal_sdio_function_id_t;

typedef enum {
    HAL_SDIO_EVENT_SUCCESS = 0,                  
    HAL_SDIO_EVENT_TRANSFER_ERROR = -1,          
    HAL_SDIO_EVENT_CRC_ERROR = -2,               
    HAL_SDIO_EVENT_DATA_TIMEOUT = -3,            
}hal_sdio_callback_event_t;

typedef struct {
    hal_sdio_bus_width_t bus_width;                                    
    uint32_t clock;                                                    
} hal_sdio_config_t;


typedef struct {
    hal_sdio_direction_t direction;                                    
    hal_sdio_function_id_t function;                                   
    bool block;                                                        
    hal_sdio_command53_operation_t operation;                          
    uint16_t count;                                                    
    uint32_t address;                                                  
    uint32_t buffer;                                                   
} hal_sdio_command53_config_t;


typedef struct {
    hal_sdio_direction_t direction;                                    
    hal_sdio_function_id_t function;                                   
    bool read_after_write;                                             
    bool stop;                                                         
    uint8_t data;                                                      
    uint32_t address;                                                  
} hal_sdio_command52_config_t;

typedef void (*hal_sdio_callback_t)(hal_sdio_callback_event_t event, void *user_data);
hal_sdio_status_t hal_sdio_register_callback(hal_sdio_port_t sdio_port, hal_sdio_callback_t sdio_callback,void *user_data);

hal_sdio_status_t hal_sdio_init(hal_sdio_port_t sdio_port, hal_sdio_config_t *sdio_config);


hal_sdio_status_t hal_sdio_deinit(hal_sdio_port_t sdio_port);


hal_sdio_status_t hal_sdio_set_clock(hal_sdio_port_t sdio_port, uint32_t clock);


hal_sdio_status_t hal_sdio_get_clock(hal_sdio_port_t sdio_port, uint32_t *clock);


hal_sdio_status_t hal_sdio_set_bus_width(hal_sdio_port_t sdio_port, hal_sdio_bus_width_t bus_width);


hal_sdio_status_t hal_sdio_set_block_size(hal_sdio_port_t sdio_port, hal_sdio_function_id_t function, uint32_t block_size);


hal_sdio_status_t hal_sdio_get_block_size(hal_sdio_port_t sdio_port, hal_sdio_function_id_t function, uint32_t *block_size);


hal_sdio_status_t hal_sdio_execute_command52(hal_sdio_port_t sdio_port, hal_sdio_command52_config_t *command52_config);



hal_sdio_status_t hal_sdio_execute_command53(hal_sdio_port_t sdio_port, hal_sdio_command53_config_t *command53_config);

hal_sdio_status_t hal_sdio_execute_command53_dma_blocking(hal_sdio_port_t sdio_port, hal_sdio_command53_config_t *command53_config);

hal_sdio_status_t hal_sdio_execute_command53_dma(hal_sdio_port_t sdio_port, hal_sdio_command53_config_t *command53_config);


#ifdef __cplusplus
}
#endif


#endif /*HAL_SDIO_MODULE_ENABLED*/
#endif /* __HAL_SDIO_H__ */