hal_platform.h

/* Copyright Statement:
 *
 * (C) 2005-2016  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_PLATFORM_H__
#define __HAL_PLATFORM_H__


#include "hal_define.h"
#include "hal_feature_config.h"
#include "mt7687.h"

#ifdef __cplusplus
extern "C" {
#endif


/*****************************************************************************
* module sub features define
*****************************************************************************/
#ifdef HAL_ADC_MODULE_ENABLED
#define HAL_ADC_FEATURE_NO_NEED_PINMUX             /*please not to modify*/
#endif

#ifdef HAL_I2C_MASTER_MODULE_ENABLED
#define HAL_I2C_MASTER_FEATURE_SEND_TO_RECEIVE  /* Enable I2C master send to receive feature. */
#endif

#ifdef HAL_PWM_MODULE_ENABLED
#define HAL_PWM_FEATURE_SINGLE_SOURCE_CLOCK        /*please not to modify*/
#endif

#ifdef HAL_EINT_MODULE_ENABLED
#define HAL_EINT_FEATURE_MASK                /* Supports EINT mask interrupt. */
#define HAL_EINT_FEATURE_SW_TRIGGER_EINT     /* Supports software triggered EINT interrupt. */
#endif

#ifdef HAL_GPIO_MODULE_ENABLED
#define HAL_GPIO_FEATURE_SET_DRIVING       /* The pin can be configured to enhance driving. For more details, please refer to hal_gpio.h. */
#endif

#ifdef HAL_RTC_MODULE_ENABLED
#define HAL_RTC_FEATURE_SLEEP        /*please not to modify*/
#endif

#ifdef HAL_UART_MODULE_ENABLED
#define HAL_UART_FEATURE_VFIFO_DMA_TIMEOUT        /*please not to modify*/
#endif

#ifdef HAL_I2S_MODULE_ENABLED
#define HAL_I2S_EXTENDED                        /*please not to modify*/
#define HAL_I2S_SUPPORT_VFIFO                   /*please not to modify*/
#endif

#ifdef HAL_GDMA_MODULE_ENABLED
#define HAL_GDMA_WRAP_FLASH_ADDRESS_TO_VIRTUAL_ADDRESS       /*please not to modify*/
#endif


#ifdef HAL_UART_MODULE_ENABLED

/*****************************************************************************
* uart
*****************************************************************************/
typedef enum {
    HAL_UART_0 = 0,                            
    HAL_UART_1 = 1,                            
    HAL_UART_MAX
} hal_uart_port_t;

#endif


#ifdef HAL_I2C_MASTER_MODULE_ENABLED

#define HAL_I2C_MAXIMUM_POLLING_TRANSACTION_SIZE  8

#define HAL_I2C_MAXIMUM_DMA_TRANSACTION_SIZE   65535


/*****************************************************************************
* i2c master
*****************************************************************************/
typedef enum {
    HAL_I2C_MASTER_0 = 0,           
    HAL_I2C_MASTER_1 = 1,           
    HAL_I2C_MASTER_MAX              
} hal_i2c_port_t;

#endif


#ifdef HAL_GPIO_MODULE_ENABLED

/*****************************************************************************
* gpio
*****************************************************************************/
typedef enum {
    HAL_GPIO_0 = 0,                       
    HAL_GPIO_1 = 1,                       
    HAL_GPIO_2 = 2,                       
    HAL_GPIO_3 = 3,                       
    HAL_GPIO_4 = 4,                       
    HAL_GPIO_5 = 5,                       
    HAL_GPIO_6 = 6,                       
    HAL_GPIO_7 = 7,                       
    HAL_GPIO_24 = 24,                     
    HAL_GPIO_25 = 25,                     
    HAL_GPIO_26 = 26,                     
    HAL_GPIO_27 = 27,                     
    HAL_GPIO_28 = 28,                     
    HAL_GPIO_29 = 29,                     
    HAL_GPIO_30 = 30,                     
    HAL_GPIO_31 = 31,                     
    HAL_GPIO_32 = 32,                     
    HAL_GPIO_33 = 33,                     
    HAL_GPIO_34 = 34,                     
    HAL_GPIO_35 = 35,                     
    HAL_GPIO_36 = 36,                     
    HAL_GPIO_37 = 37,                     
    HAL_GPIO_38 = 38,                     
    HAL_GPIO_39 = 39,                     
    HAL_GPIO_57 = 57,                     
    HAL_GPIO_58 = 58,                     
    HAL_GPIO_59 = 59,                     
    HAL_GPIO_60 = 60,                     
    HAL_GPIO_MAX                          
} hal_gpio_pin_t;

#endif

#ifdef HAL_ADC_MODULE_ENABLED

/*****************************************************************************
* adc
*****************************************************************************/
typedef enum {
    HAL_ADC_CHANNEL_0 = 0,                   
    HAL_ADC_CHANNEL_1 = 1,                   
    HAL_ADC_CHANNEL_2 = 2,                   
    HAL_ADC_CHANNEL_3 = 3,                   
    HAL_ADC_CHANNEL_MAX                      
} hal_adc_channel_t;

#endif



#ifdef HAL_I2S_MODULE_ENABLED

/*****************************************************************************
* i2s
*****************************************************************************/
typedef enum {
    HAL_I2S_TYPE_EXTERNAL_MODE          = 0,        
    HAL_I2S_TYPE_EXTERNAL_TDM_MODE      = 1,        
    HAL_I2S_TYPE_INTERNAL_MODE          = 2,        
    HAL_I2S_TYPE_INTERNAL_LOOPBACK_MODE = 3         
} hal_i2s_initial_type_t;

typedef enum {
    HAL_I2S_EVENT_DATA_REQUEST        =  0, 
    HAL_I2S_EVENT_DATA_NOTIFICATION   =  1  
} hal_i2s_event_t;

typedef enum {
    HAL_I2S_SAMPLE_RATE_8K        = 0,  
    HAL_I2S_SAMPLE_RATE_12K       = 1,  
    HAL_I2S_SAMPLE_RATE_16K       = 2,  
    HAL_I2S_SAMPLE_RATE_24K       = 3,  
    HAL_I2S_SAMPLE_RATE_32K       = 4,  
    HAL_I2S_SAMPLE_RATE_48K       = 5,  
} hal_i2s_sample_rate_t;

typedef enum {
    HAL_I2S_SAMPLE_WIDTH_8BIT  = 0,   
    HAL_I2S_SAMPLE_WIDTH_16BIT = 1,   
    HAL_I2S_SAMPLE_WIDTH_24BIT = 2    
} hal_i2s_sample_width_t;

typedef enum {
    HAL_I2S_FRAME_SYNC_WIDTH_32  = 0,   
    HAL_I2S_FRAME_SYNC_WIDTH_64  = 1,   
    HAL_I2S_FRAME_SYNC_WIDTH_128  = 2   
} hal_i2s_frame_sync_width_t;

typedef enum {
    HAL_I2S_TX_MONO_DUPLICATE_DISABLE = 0,  
    HAL_I2S_TX_MONO_DUPLICATE_ENABLE  = 1   
} hal_i2s_tx_mode_t;

typedef enum {
    HAL_I2S_RX_DOWN_RATE_DISABLE = 0,  
    HAL_I2S_RX_DOWN_RATE_ENABLE  = 1   
} hal_i2s_rx_down_rate_t;

typedef enum {
    HAL_I2S_LR_SWAP_DISABLE = 0,  
    HAL_I2S_LR_SWAP_ENABLE  = 1   
} hal_i2s_lr_swap_t;

typedef enum {
    HAL_I2S_WORD_SELECT_INVERSE_DISABLE = 0,  
    HAL_I2S_WORD_SELECT_INVERSE_ENABLE  = 1   
} hal_i2s_word_select_inverse_t;

#endif


#ifdef HAL_SPI_MASTER_MODULE_ENABLED

#define HAL_SPI_MAXIMUM_POLLING_TRANSACTION_SIZE  0xFFFFFFFF

#define HAL_SPI_MASTER_CLOCK_MIN_FREQUENCY 30000

#define HAL_SPI_MASTER_CLOCK_MAX_FREQUENCY 60000000


/*****************************************************************************
* spi master
*****************************************************************************/
typedef enum {
    HAL_SPI_MASTER_0 = 0,                             
    HAL_SPI_MASTER_MAX                                
} hal_spi_master_port_t;


typedef enum {
    HAL_SPI_MASTER_SLAVE_0 = 0,                       
    HAL_SPI_MASTER_SLAVE_1 = 1,                       
    HAL_SPI_MASTER_SLAVE_MAX                          
} hal_spi_master_slave_port_t;

typedef enum {
    HAL_SPI_MASTER_CLOCK_POLARITY0 = 0,                     
    HAL_SPI_MASTER_CLOCK_POLARITY1 = 1                      
} hal_spi_master_clock_polarity_t;


typedef enum {
    HAL_SPI_MASTER_CLOCK_PHASE0 = 0,                         
    HAL_SPI_MASTER_CLOCK_PHASE1 = 1                          
} hal_spi_master_clock_phase_t;


typedef enum {
    HAL_SPI_MASTER_LSB_FIRST = 0,                       
    HAL_SPI_MASTER_MSB_FIRST = 1                        
} hal_spi_master_bit_order_t;

#endif

#ifdef HAL_SPI_SLAVE_MODULE_ENABLED

/*****************************************************************************
* spi slave
*****************************************************************************/
typedef enum {
    HAL_SPI_SLAVE_0 = 0,                             
    HAL_SPI_SLAVE_MAX                                
} hal_spi_slave_port_t;

typedef enum {
    HAL_SPI_SLAVE_CLOCK_POLARITY0 = 0,                 
    HAL_SPI_SLAVE_CLOCK_POLARITY1 = 1                  
} hal_spi_slave_clock_polarity_t;


typedef enum {
    HAL_SPI_SLAVE_CLOCK_PHASE0 = 0,                    
    HAL_SPI_SLAVE_CLOCK_PHASE1 = 1                     
} hal_spi_slave_clock_phase_t;

#endif


#ifdef HAL_RTC_MODULE_ENABLED

/*****************************************************************************
* rtc
*****************************************************************************/
#define HAL_RTC_BACKUP_BYTE_NUM_MAX     (144)

typedef struct {
    uint8_t rtc_sec;                                  
    uint8_t rtc_min;                                  
    uint8_t rtc_hour;                                 
    uint8_t rtc_day;                                  
    uint8_t rtc_mon;                                  
    uint8_t rtc_week;                                 
    uint8_t rtc_year;                                 
} hal_rtc_time_t;
#endif


#ifdef HAL_EINT_MODULE_ENABLED

/*****************************************************************************
* eint
*****************************************************************************/
typedef enum {
    HAL_EINT_NUMBER_0 = 0,
    HAL_EINT_NUMBER_1 = 1,
    HAL_EINT_NUMBER_2 = 2,
    HAL_EINT_NUMBER_3 = 3,
    HAL_EINT_NUMBER_4 = 4,
    HAL_EINT_NUMBER_5 = 5,
    HAL_EINT_NUMBER_6 = 6,
    HAL_EINT_NUMBER_19 = 19,
    HAL_EINT_NUMBER_20 = 20,
    HAL_EINT_NUMBER_21 = 21,
    HAL_EINT_NUMBER_22 = 22,
    HAL_WIC_NUMBER_0    = 32,
    HAL_WIC_NUMBER_1    = 33,
    HAL_WIC_NUMBER_2    = 34,
    HAL_WIC_NUMBER_3    = 35,
    HAL_WIC_NUMBER_4    = 36,
    HAL_WIC_NUMBER_5    = 37,
    HAL_WIC_NUMBER_6    = 38,
    HAL_WIC_NUMBER_7    = 39,
    HAL_WIC_NUMBER_8    = 40,
    HAL_WIC_NUMBER_9    = 41,
    HAL_WIC_NUMBER_10   = 42,
    HAL_WIC_NUMBER_11   = 43,
    HAL_EINT_NUMBER_MAX
} hal_eint_number_t;

#endif

#ifdef HAL_GPT_MODULE_ENABLED

/*****************************************************************************
* gpt
*****************************************************************************/
typedef enum {
    HAL_GPT_0 = 0,                         
    HAL_GPT_1 = 1,                         
    HAL_GPT_2 = 2,                         
    HAL_GPT_4 = 4,                         
    HAL_GPT_MAX                            
} hal_gpt_port_t;

typedef enum {
    HAL_GPT_CLOCK_SOURCE_32K = 0,           
    HAL_GPT_CLOCK_SOURCE_1M  = 1,           
    HAL_GPT_CLOCK_SOURCE_BUS = 2            
} hal_gpt_clock_source_t;

#define HAL_GPT_MAXIMUM_MS_TIMER_TIME    (130150523)

#endif

#ifdef HAL_FLASH_MODULE_ENABLED

/*****************************************************************************
* Flash
*****************************************************************************/

#define HAL_FLASH_BASE_ADDRESS    (0x08000000)


#endif

#ifdef HAL_GDMA_MODULE_ENABLED

/*****************************************************************************
* gdma
*****************************************************************************/
typedef enum {
    HAL_GDMA_CHANNEL_0 = 0,                        
    HAL_GDMA_CHANNEL_1 = 1,                        
    HAL_GDMA_CHANNEL_MAX                           
} hal_gdma_channel_t;

#ifdef  HAL_GDMA_WRAP_FLASH_ADDRESS_TO_VIRTUAL_ADDRESS

#define HAL_GDMA_WRAP_FLASH_ADDRESS_OFFSET          (28)

#define HAL_GDMA_WRAP_FLASH_ADDRESS_HIGH_BYTE_MASK  (0xfUL<<HAL_GDMA_WRAP_FLASH_ADDRESS_OFFSET)

#define HAL_GDMA_WRAP_FLASH_ADDRESS_MASK            (0x1UL<<HAL_GDMA_WRAP_FLASH_ADDRESS_OFFSET)

#define HAL_GDMA_WRAP_FLASH_VIRTUAL_ADDRESS_MASK    (0x3UL<<HAL_GDMA_WRAP_FLASH_ADDRESS_OFFSET)

#endif

#endif

#ifdef HAL_PWM_MODULE_ENABLED

/*****************************************************************************
* pwm
*****************************************************************************/
typedef enum {
    HAL_PWM_0  = 0,                        
    HAL_PWM_1  = 1,                        
    HAL_PWM_2  = 2,                        
    HAL_PWM_3  = 3,                        
    HAL_PWM_4  = 4,                        
    HAL_PWM_5  = 5,                        
    HAL_PWM_18 = 18,                       
    HAL_PWM_19 = 19,                       
    HAL_PWM_20 = 20,                       
    HAL_PWM_21 = 21,                       
    HAL_PWM_22 = 22,                       
    HAL_PWM_23 = 23,                       
    HAL_PWM_24 = 24,                       
    HAL_PWM_25 = 25,                       
    HAL_PWM_26 = 26,                       
    HAL_PWM_27 = 27,                       
    HAL_PWM_28 = 28,                       
    HAL_PWM_29 = 29,                       
    HAL_PWM_30 = 30,                       
    HAL_PWM_31 = 31,                       
    HAL_PWM_32 = 32,                       
    HAL_PWM_33 = 33,                       
    HAL_PWM_34 = 34,                       
    HAL_PWM_35 = 35,                       
    HAL_PWM_36 = 36,                       
    HAL_PWM_37 = 37,                       
    HAL_PWM_38 = 38,                       
    HAL_PWM_39 = 39,                       
    HAL_PWM_MAX_CHANNEL                    
} hal_pwm_channel_t;

typedef enum {
    HAL_PWM_CLOCK_32KHZ  = 0,               
    HAL_PWM_CLOCK_2MHZ   = 1,               
    HAL_PWM_CLOCK_20MHZ  = 2,               
    HAL_PWM_CLOCK_26MHZ  = 3,               
    HAL_PWM_CLOCK_40MHZ  = 4,               
    HAL_PWM_CLOCK_52MHZ  = 5,               
    HAL_PWM_CLOCK_MAX                       
} hal_pwm_source_clock_t ;

#endif



#ifdef HAL_GPC_MODULE_ENABLED

typedef enum {
    HAL_GPC_0 = 0,                          
    HAL_GPC_MAX_PORT                        
} hal_gpc_port_t;


#endif



#ifdef HAL_SLEEP_MANAGER_ENABLED

/*****************************************************************************
 * Enum
 *****************************************************************************/
typedef enum {
    HAL_SLEEP_MODE_NONE = 0,        
    HAL_SLEEP_MODE_IDLE,            
    HAL_SLEEP_MODE_SLEEP,           
    HAL_SLEEP_MODE_LEGACY_SLEEP,    
    HAL_SLEEP_MODE_NUMBER           
} hal_sleep_mode_t;
#endif

#ifdef HAL_WDT_MODULE_ENABLED

/*****************************************************************************
* WDT
*****************************************************************************/
#define WDT_RESTART_ADDRESS    (0x83080038)
#define WDT_RESTART_KEY        (0x1971)

#endif

#ifdef __cplusplus
}
#endif

#endif /* __HAL_PLATFORM_H__ */