hwbp_core.h

Go to the documentation of this file.

#ifndef _HWBP_CORE_H_
#define _HWBP_CORE_H_
#include <avr/io.h>
 
 
 
// Define if not defined
#ifndef bool
    #define bool uint8_t
#endif
#ifndef true
    #define true 1
    #define false 0
#endif
 
typedef struct {
    uint32_t second;
    uint16_t usecond;
} timestamp_t;
 
void core_callback_define_clock_default(void);
 
void core_callback_initialize_hardware(void);
 
void core_callback_reset_registers(void);
 
void core_callback_registers_were_reinitialized(void);
 
void core_callback_visualen_to_on(void);
void core_callback_visualen_to_off(void);
 
void core_callback_device_to_standby(void);
void core_callback_device_to_active(void);
void core_callback_device_to_speed(void);
 
 
void core_callback_t_before_exec(void);
void core_callback_t_after_exec(void);
 
void core_callback_t_1ms(void);
void core_callback_t_500us(void);
void core_callback_t_new_second(void);
 
 
bool core_read_app_register(uint8_t add, uint8_t type);
bool core_write_app_register(uint8_t add, uint8_t type, uint8_t * content, uint16_t n_elements);
bool hwbp_read_common_reg(uint8_t add, uint8_t type);
bool hwbp_write_common_reg(uint8_t add, uint8_t type, uint8_t * content, uint16_t n_elements);
 
 
/************************************************************************/
/* Register RESET_APP                                                   */
/************************************************************************/
bool hwbp_write_common_reg_RESET_APP(void *a);
 
bool core_save_all_registers_to_eeprom(void);
 
 
/************************************************************************/
/* Register CONFIG                                                      */
/************************************************************************/
bool hwbp_write_common_reg_CONFIG(void *a);
void hwbp_read_common_reg_CONFIG(void);
 
void core_callback_clock_to_repeater(void);
void core_callback_clock_to_generator(void);
void core_callback_clock_to_unlock(void);
void core_callback_clock_to_lock(void);
 
bool core_bool_device_is_repeater(void);
bool core_bool_device_is_generator(void);
bool core_bool_clock_is_locked(void);
 
bool core_device_to_clock_repeater(void);
bool core_device_to_clock_generator(void);
bool core_clock_to_lock(void);
bool core_clock_to_unlock(void);
 
 
void core_func_start_core (
    const uint16_t who_am_i,
    const uint8_t hwH,
    const uint8_t hwL,
    const uint8_t fwH,
    const uint8_t fwL,
    const uint8_t assembly,
    uint8_t *pointer_to_app_regs,
    const uint16_t app_mem_size_to_save,
    const uint8_t num_of_app_registers,
    const uint8_t *device_name,
    const bool  device_is_able_to_repeat_clock,
    const bool  device_is_able_to_generate_clock,
    const uint8_t default_timestamp_offset
    );
 
void core_func_catastrophic_error_detected(void);
void core_callback_catastrophic_error_detected(void);
 
void core_func_leave_speed_mode_and_go_to_standby_mode(void);
 
 
void core_func_update_user_timestamp(uint32_t seconds, uint16_t useconds);
 
void core_func_read_user_timestamp(uint32_t *seconds, uint16_t *useconds);
 
void core_func_mark_user_timestamp(void);
 
void core_func_send_event(uint8_t add, bool use_core_timestamp);
 
uint32_t core_func_read_R_TIMESTAMP_SECOND(void);
uint16_t core_func_read_R_TIMESTAMP_MICRO(void);
 
 
 
 
bool core_bool_is_visual_enabled(void);
bool core_bool_speed_mode_is_in_use(void);
bool core_bool_device_is_active(void);
bool core_bool_device_is_synchronized(void);
 
 
 
#endif /* _HWBP_CORE_H_ */