hal_spi_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_SPI_SLAVE_H__
#define __HAL_SPI_SLAVE_H__

#include "hal_platform.h"

#ifdef HAL_SPI_SLAVE_MODULE_ENABLED

#ifdef HAL_SPI_SLAVE_FEATURE_SW_CONTROL

#else

#endif

#ifdef HAL_GPIO_FEATURE_SET_DRIVING

#endif

#ifdef __cplusplus
extern "C" {
#endif

#ifdef HAL_SPI_SLAVE_FEATURE_SW_CONTROL

typedef enum {
    HAL_SPI_SLAVE_EARLY_MISO_DISABLE = 0,            
    HAL_SPI_SLAVE_EARLY_MISO_ENABLE  = 1             
} hal_spi_slave_early_miso_t;


typedef enum {
    HAL_SPI_SLAVE_BUSY              = 0,             
    HAL_SPI_SLAVE_IDLE              = 1              
} hal_spi_slave_running_status_t;


/********************* SPI Slave FSM *******************************
**cmd\status    PWROFF    PWRON    ConfigRead(CR)    ConfigWrite(CW)
** Poweroff       N         Y         Abnormal          Abnormal
** Poweron        Y         N             N                N
**ConfigRead      N         Y         Abnormal          Abnormal
**  Read          N         N             Y             Abnormal
**ConfigWrite     N         Y         Abnormal          Abnormal
**  Write         N         N         Abnormal             Y

Note: N: invalid operation.
      Y: the operation completed successfully.
      Abnormal: an error occurred during the operation.
*******************************************************************/
typedef enum {
    HAL_SPI_SLAVE_FSM_SUCCESS_OPERATION      = 0x00,         
    HAL_SPI_SLAVE_FSM_INVALID_OPERATION      = 0x01,         
    HAL_SPI_SLAVE_FSM_ERROR_PWROFF_AFTER_CR  = 0x02,         
    HAL_SPI_SLAVE_FSM_ERROR_PWROFF_AFTER_CW  = 0x03,         
    HAL_SPI_SLAVE_FSM_ERROR_CONTINOUS_CR     = 0x04,         
    HAL_SPI_SLAVE_FSM_ERROR_CR_AFTER_CW      = 0x05,         
    HAL_SPI_SLAVE_FSM_ERROR_CONTINOUS_CW     = 0x06,         
    HAL_SPI_SLAVE_FSM_ERROR_CW_AFTER_CR      = 0x07,         
    HAL_SPI_SLAVE_FSM_ERROR_WRITE_AFTER_CR   = 0x08,         
    HAL_SPI_SLAVE_FSM_ERROR_READ_AFTER_CW    = 0x09          
} hal_spi_slave_fsm_status_t;

#endif


typedef enum {
    HAL_SPI_SLAVE_STATUS_ERROR             = -4,            
    HAL_SPI_SLAVE_STATUS_ERROR_BUSY        = -3,            
    HAL_SPI_SLAVE_STATUS_ERROR_PORT        = -2,            
    HAL_SPI_SLAVE_STATUS_INVALID_PARAMETER = -1,            
    HAL_SPI_SLAVE_STATUS_OK                = 0              
} hal_spi_slave_status_t;

#ifdef HAL_SPI_SLAVE_FEATURE_SW_CONTROL

typedef struct {
    uint32_t timeout_threshold;                      
    hal_spi_slave_bit_order_t bit_order;             
    hal_spi_slave_clock_polarity_t polarity;         
    hal_spi_slave_clock_phase_t phase;               
} hal_spi_slave_config_t;


typedef struct {
    hal_spi_slave_fsm_status_t fsm_status;           
    hal_spi_slave_callback_event_t interrupt_status; 
} hal_spi_slave_transaction_status_t;
#else

typedef struct {
    hal_spi_slave_clock_polarity_t polarity;         
    hal_spi_slave_clock_phase_t phase;               
} hal_spi_slave_config_t;
#endif

#ifdef HAL_SPI_SLAVE_FEATURE_SW_CONTROL

typedef void (* hal_spi_slave_callback_t)(hal_spi_slave_transaction_status_t status, void *user_data);
#else

typedef void (* hal_spi_slave_callback_t)(void *user_data);
#endif

#ifdef HAL_SPI_SLAVE_FEATURE_SW_CONTROL

hal_spi_slave_status_t hal_spi_slave_init(hal_spi_slave_port_t spi_port, hal_spi_slave_config_t *spi_configure);


hal_spi_slave_status_t hal_spi_slave_deinit(hal_spi_slave_port_t spi_port);


hal_spi_slave_status_t hal_spi_slave_register_callback(hal_spi_slave_port_t spi_port, hal_spi_slave_callback_t callback_function, void *user_data);


hal_spi_slave_status_t hal_spi_slave_send(hal_spi_slave_port_t spi_port, const uint8_t *data, uint32_t size);


hal_spi_slave_status_t hal_spi_slave_get_master_read_config(hal_spi_slave_port_t spi_port, uint32_t *address, uint32_t *length);


hal_spi_slave_status_t hal_spi_slave_receive(hal_spi_slave_port_t spi_port, uint8_t *buffer, uint32_t size);


hal_spi_slave_status_t hal_spi_slave_get_master_write_config(hal_spi_slave_port_t spi_port, uint32_t *address, uint32_t *length);


hal_spi_slave_status_t hal_spi_slave_set_early_miso(hal_spi_slave_port_t spi_port, hal_spi_slave_early_miso_t early_miso);


hal_spi_slave_status_t hal_spi_slave_set_command(hal_spi_slave_port_t spi_port, hal_spi_slave_command_type_t command, uint8_t value);
#else

hal_spi_slave_status_t hal_spi_slave_init(hal_spi_slave_port_t spi_port, hal_spi_slave_config_t *spi_configure);


hal_spi_slave_status_t hal_spi_slave_register_callback(hal_spi_slave_port_t spi_port, hal_spi_slave_callback_t callback_function, void *user_data);

#endif

#ifdef __cplusplus
}
#endif

#endif /*HAL_SPI_SLAVE_MODULE_ENABLED*/
#endif /* __HAL_SPI_SLAVE_H__ */