systick.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __SYS_TICK_H__
#define __SYS_TICK_H__
 
/*============================ INCLUDES ======================================*/
#include "hal/vsf_hal_cfg.h"
#include "./systick_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
/*============================ MACROS ========================================*/
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#define vsf_systick_cfg(...)                    \
        do {                                    \
            systick_cfg_t cfg = {__VA_ARGS__}; \
            vsf_systick_init(&cfg);            \
        } while(false)
 
/*============================ TYPES =========================================*/
 
/* defined in systick_internal.h
typedef enum {
    DISABLE_SYSTICK                         = 0x00,
    ENABLE_SYSTICK                          = 0x01, 
 
    DISABLE_SYSTICK_INTERRUPT               = 0x00,
    ENABLE_SYSTICK_INTERRUPT                = 0x02, 
 
    SYSTICK_SOURCE_REFERCLK                 = 0x00,
    SYSTICK_SOURCE_SYSCLK                   = 0x04,
} em_systick_cfg_mode_t;
 
typedef struct {
    uint8_t         mode;                           //!< config ward
    uint32_t        reload_value;                   //!< Match value
}systick_cfg_t;
*/
 
declare_interface(systick_t)
 
 
def_interface(systick_t)
    bool            (*Init)(systick_cfg_t *);       
    void            (*Enable)(void);                
    bool            (*Disable)(void);               
    bool            (*IsMatch)(void);               
    u32_property_t  Counter;                        
    void            (*Reset)(void);                 
    systick_reg_t   *const RegPage;                 
end_def_interface(systick_t)
/*============================ GLOBAL VARIABLES ==============================*/
extern const systick_t SYSTICK;
/*============================ LOCAL VARIABLES ===============================*/
/*============================ PROTOTYPES ====================================*/
 
#ifdef __cplusplus
}
#endif
 
#endif  /* end of __SYS_TICK_H__ */