hal_spi_master.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_SPI_MASTER_H__
#define __HAL_SPI_MASTER_H__
#include "hal_platform.h"

#ifdef HAL_SPI_MASTER_MODULE_ENABLED


#ifdef HAL_SPI_MASTER_FEATURE_DMA_MODE

#else

#endif

#ifdef HAL_SPI_MASTER_FEATURE_DMA_MODE

#endif

#ifdef HAL_SPI_MASTER_FEATURE_DMA_MODE

#endif
#ifdef HAL_SPI_MASTER_FEATURE_DMA_MODE

#else

#endif

#ifdef HAL_GPIO_FEATURE_SET_DRIVING

#endif

#ifdef __cplusplus
extern "C" {
#endif

#ifdef HAL_SPI_MASTER_FEATURE_ADVANCED_CONFIG

typedef enum {
    HAL_SPI_MASTER_LITTLE_ENDIAN = 0,                       
    HAL_SPI_MASTER_BIG_ENDIAN    = 1                        
} hal_spi_master_byte_order_t;


typedef enum {
    HAL_SPI_MASTER_CHIP_SELECT_LOW  = 0,                
    HAL_SPI_MASTER_CHIP_SELECT_HIGH = 1                 
} hal_spi_master_chip_select_polarity_t;


typedef enum {
    HAL_SPI_MASTER_NO_GET_TICK_MODE = 0,              
    HAL_SPI_MASTER_GET_TICK_DELAY1  = 1,              
    HAL_SPI_MASTER_GET_TICK_DELAY2  = 2,              
    HAL_SPI_MASTER_GET_TICK_DELAY3  = 3,              
    HAL_SPI_MASTER_GET_TICK_DELAY4  = 4,              
    HAL_SPI_MASTER_GET_TICK_DELAY5  = 5,              
    HAL_SPI_MASTER_GET_TICK_DELAY6  = 6,              
    HAL_SPI_MASTER_GET_TICK_DELAY7  = 7               
} hal_spi_master_get_tick_mode_t;


typedef enum {
    HAL_SPI_MASTER_SAMPLE_POSITIVE = 0,               
    HAL_SPI_MASTER_SAMPLE_NEGATIVE = 1                
} hal_spi_master_sample_select_t;
#endif


#ifdef HAL_SPI_MASTER_FEATURE_DEASSERT_CONFIG

typedef enum {
    HAL_SPI_MASTER_DEASSERT_DISABLE = 0,              
    HAL_SPI_MASTER_DEASSERT_ENABLE  = 1               
} hal_spi_master_deassert_t;
#endif


#ifdef HAL_SPI_MASTER_FEATURE_MACRO_CONFIG

typedef enum {
    HAL_SPI_MASTER_MACRO_GROUP_A = 0,                   
    HAL_SPI_MASTER_MACRO_GROUP_B = 1,                   
    HAL_SPI_MASTER_MACRO_GROUP_C = 2                    
} hal_spi_master_macro_select_t;
#endif

#ifdef HAL_SPI_MASTER_FEATURE_DMA_MODE

typedef enum {
    HAL_SPI_MASTER_EVENT_SEND_FINISHED      = 0,             
    HAL_SPI_MASTER_EVENT_RECEIVE_FINISHED   = 1              
} hal_spi_master_callback_event_t;
#endif

typedef enum {
    HAL_SPI_MASTER_STATUS_ERROR             = -4,            
    HAL_SPI_MASTER_STATUS_ERROR_BUSY        = -3,            
    HAL_SPI_MASTER_STATUS_ERROR_PORT        = -2,            
    HAL_SPI_MASTER_STATUS_INVALID_PARAMETER = -1,            
    HAL_SPI_MASTER_STATUS_OK                = 0              
} hal_spi_master_status_t;


typedef enum {
    HAL_SPI_MASTER_BUSY              = 0,             
    HAL_SPI_MASTER_IDLE              = 1              
} hal_spi_master_running_status_t;

typedef struct {
    uint32_t clock_frequency;                                   
    hal_spi_master_slave_port_t slave_port;                     
    hal_spi_master_bit_order_t bit_order;                       
    hal_spi_master_clock_polarity_t polarity;                   
    hal_spi_master_clock_phase_t phase;                         
} hal_spi_master_config_t;

#ifdef HAL_SPI_MASTER_FEATURE_ADVANCED_CONFIG

typedef struct {
    hal_spi_master_byte_order_t byte_order;                     
    hal_spi_master_chip_select_polarity_t chip_polarity;        
    hal_spi_master_get_tick_mode_t get_tick;                    
    hal_spi_master_sample_select_t sample_select;               
} hal_spi_master_advanced_config_t;
#endif


#ifdef HAL_SPI_MASTER_FEATURE_CHIP_SELECT_TIMING

typedef struct {
    uint32_t chip_select_setup_count;                 
    uint32_t chip_select_hold_count;                  
    uint32_t chip_select_idle_count;                  
} hal_spi_master_chip_select_timing_t;
#endif


typedef struct {
    uint8_t *send_data;                               
    uint32_t send_length;                             
    uint8_t *receive_buffer;                          
    uint32_t receive_length;                          
} hal_spi_master_send_and_receive_config_t;


#ifdef HAL_SPI_MASTER_FEATURE_DMA_MODE

typedef void (*hal_spi_master_callback_t)(hal_spi_master_callback_event_t event, void *user_data);

#endif

hal_spi_master_status_t hal_spi_master_init(hal_spi_master_port_t master_port,
        hal_spi_master_config_t *spi_config);

hal_spi_master_status_t hal_spi_master_deinit(hal_spi_master_port_t master_port);

#ifdef HAL_SPI_MASTER_FEATURE_ADVANCED_CONFIG

hal_spi_master_status_t hal_spi_master_set_advanced_config(hal_spi_master_port_t master_port,
        hal_spi_master_advanced_config_t *advanced_config);
#endif


hal_spi_master_status_t hal_spi_master_send_polling(hal_spi_master_port_t master_port,
        uint8_t *data,
        uint32_t size);

#ifdef HAL_SPI_MASTER_FEATURE_DMA_MODE

hal_spi_master_status_t hal_spi_master_send_dma(hal_spi_master_port_t master_port,
        uint8_t *data,
        uint32_t size);

hal_spi_master_status_t hal_spi_master_send_dma_blocking(hal_spi_master_port_t master_port,
        uint8_t *data,
        uint32_t size);
#endif

hal_spi_master_status_t hal_spi_master_send_and_receive_polling(hal_spi_master_port_t master_port,
        hal_spi_master_send_and_receive_config_t *spi_send_and_receive_config);

#ifdef HAL_SPI_MASTER_FEATURE_DMA_MODE

hal_spi_master_status_t hal_spi_master_send_and_receive_dma(hal_spi_master_port_t master_port,
        hal_spi_master_send_and_receive_config_t *spi_send_and_receive_config);

hal_spi_master_status_t hal_spi_master_send_and_receive_dma_blocking(hal_spi_master_port_t master_port,
        hal_spi_master_send_and_receive_config_t *spi_send_and_receive_config);
#endif

hal_spi_master_status_t hal_spi_master_get_running_status(hal_spi_master_port_t master_port,
        hal_spi_master_running_status_t *running_status);


#ifdef HAL_SPI_MASTER_FEATURE_CHIP_SELECT_TIMING

hal_spi_master_status_t hal_spi_master_set_chip_select_timing(hal_spi_master_port_t master_port,
        hal_spi_master_chip_select_timing_t chip_select_timing);
#endif


#ifdef HAL_SPI_MASTER_FEATURE_DEASSERT_CONFIG

hal_spi_master_status_t hal_spi_master_set_deassert(hal_spi_master_port_t master_port,
        hal_spi_master_deassert_t deassert);
#endif


#ifdef HAL_SPI_MASTER_FEATURE_MACRO_CONFIG

hal_spi_master_status_t hal_spi_master_set_macro_selection(hal_spi_master_port_t master_port,
        hal_spi_master_macro_select_t macro_select);
#endif

#ifdef HAL_SPI_MASTER_FEATURE_DMA_MODE

hal_spi_master_status_t hal_spi_master_register_callback(hal_spi_master_port_t master_port,
        hal_spi_master_callback_t callback,
        void *user_data);
#endif

#ifdef HAL_SPI_MASTER_FEATURE_DUAL_QUAD_MODE

hal_spi_master_status_t hal_spi_master_set_mode(hal_spi_master_port_t master_port,
        hal_spi_master_mode_t mode);

hal_spi_master_status_t hal_spi_master_set_dummy_bits(hal_spi_master_port_t master_port,
        uint8_t dummy_bits);

hal_spi_master_status_t hal_spi_master_set_command_bytes(hal_spi_master_port_t master_port,
        uint8_t command_bytes);
#endif


#ifdef __cplusplus
}
#endif


#endif /*HAL_SPI_MASTER_MODULE_ENABLED*/
#endif /* __HAL_SPI_MASTER_H__ */