hal_sdio_slave.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_SLAVE_H__
#define __HAL_SDIO_SLAVE_H__

#include "hal_platform.h"

#ifdef HAL_SDIO_SLAVE_MODULE_ENABLED


#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    HAL_SDIO_SLAVE_STATUS_ERROR             = -3,       
    HAL_SDIO_SLAVE_STATUS_BUSY              = -2,       
    HAL_SDIO_SLAVE_STATUS_INVALID_PARAMETER = -1,       
    HAL_SDIO_SLAVE_STATUS_OK                = 0         
} hal_sdio_slave_status_t;

typedef enum {
    HAL_SDIO_SLAVE_TX_QUEUE_1 = 1,   
    HAL_SDIO_SLAVE_TX_QUEUE_MAX
} hal_sdio_slave_tx_queue_id_t;

typedef enum {
    HAL_SDIO_SLAVE_RX_QUEUE_0 = 0,    
    HAL_SDIO_SLAVE_RX_QUEUE_1 = 1,    
    HAL_SDIO_SLAVE_RX_QUEUE_MAX
} hal_sdio_slave_rx_queue_id_t;

typedef enum {
    HAL_SDIO_SLAVE_EVENT_ERROR = -1,                   
    HAL_SDIO_SLAVE_EVENT_RX0_DONE     = 0,             
    HAL_SDIO_SLAVE_EVENT_RX1_DONE    = 1,              
    HAL_SDIO_SLAVE_EVENT_TX1_DONE     = 2,               
    HAL_SDIO_SLAVE_EVENT_SW_INTERRUPT     = 3,           
    HAL_SDIO_SLAVE_EVENT_NONE     = 4                   
} hal_sdio_slave_callback_event_t;

typedef struct {
    uint32_t hal_sdio_slave_sw_interrupt_number;  
} hal_sdio_slave_callback_sw_interrupt_parameter_t;

typedef struct {
    uint32_t hal_sdio_slave_tx_length;    
} hal_sdio_slave_callback_tx_length_parameter_t;


typedef void (*hal_sdio_slave_callback_t)(hal_sdio_slave_callback_event_t sdio_slave_event, void *parameter, void *user_data);
hal_sdio_slave_status_t hal_sdio_slave_register_callback(hal_sdio_slave_port_t sdio_slave_port, hal_sdio_slave_callback_t sdio_slave_callback, void *user_data);


hal_sdio_slave_status_t hal_sdio_slave_init(hal_sdio_slave_port_t sdio_slave_port);

hal_sdio_slave_status_t hal_sdio_slave_deinit(hal_sdio_slave_port_t sdio_slave_port);

hal_sdio_slave_status_t hal_sdio_slave_receive_mailbox(hal_sdio_slave_port_t sdio_slave_port, uint32_t mailbox_number, uint32_t *mailbox_value);

hal_sdio_slave_status_t hal_sdio_slave_send_mailbox(hal_sdio_slave_port_t sdio_slave_port, uint32_t mailbox_number, uint32_t mailbox_value);


hal_sdio_slave_status_t hal_sdio_slave_trigger_d2h_interrupt(hal_sdio_slave_port_t sdio_slave_port, uint32_t interrupt_number);

hal_sdio_slave_status_t hal_sdio_slave_send_dma(hal_sdio_slave_port_t sdio_slave_port, hal_sdio_slave_rx_queue_id_t queue_id, const uint32_t *buffer, uint32_t size);


hal_sdio_slave_status_t hal_sdio_slave_receive_dma(hal_sdio_slave_port_t sdio_slave_port, hal_sdio_slave_tx_queue_id_t queue_id, uint32_t *buffer, uint32_t size);


#ifdef __cplusplus
}
#endif

#endif /*HAL_SDIO_SLAVE_MODULE_ENABLED*/
#endif /*__HAL_SDIO_SLAVE_H__*/