Microchip® Advanced Software Framework

winc1500/locate_ip_address_example/iot/sw_timer.h File Reference

SW Timer component for the IoT(Internet of things) service.

Copyright (c) 2016-2018 Microchip Technology Inc. and its subsidiaries.

#include <stdint.h>
#include "conf_sw_timer.h"
#include <asf.h>

Data Structures

struct  sw_timer_config
 SW timer configuration structure. More...
 
struct  sw_timer_handle
 SW timer handler structure. More...
 
struct  sw_timer_module
 SW timer module structure. More...
 

Typedefs

typedef void(* sw_timer_callback_t )(struct sw_timer_module *const module, int timer_id, void *context, int period)
 Callback Function type of time out event in the timer. More...
 

Functions

void sw_timer_disable (struct sw_timer_module *const module_inst)
 Stop the timer. More...
 
void sw_timer_disable_callback (struct sw_timer_module *const module_inst, int timer_id)
 Disable callback. More...
 
void sw_timer_enable (struct sw_timer_module *const module_inst)
 Start the timer. More...
 
void sw_timer_enable_callback (struct sw_timer_module *const module_inst, int timer_id, uint32_t delay)
 Enables callback. More...
 
void sw_timer_get_config_defaults (struct sw_timer_config *const config)
 Get default configuration of SW timer. More...
 
void sw_timer_init (struct sw_timer_module *const module_inst, struct sw_timer_config *const config)
 Initialize the SW timer module. More...
 
int sw_timer_register_callback (struct sw_timer_module *const module_inst, sw_timer_callback_t callback, void *context, uint32_t period)
 Register callback. More...
 
void sw_timer_task (struct sw_timer_module *const module_inst)
 Checks the time out of each timer handlers. More...
 
void sw_timer_unregister_callback (struct sw_timer_module *const module_inst, int timer_id)
 Unregister callback. More...
 

typedef void(* sw_timer_callback_t)(struct sw_timer_module *const module, int timer_id, void *context, int period)

Callback Function type of time out event in the timer.

Parameters
[in]timer_idID of timer.
[in]contextPrivate data of timer.
[in]contextPeriod of timer handle.

void sw_timer_disable ( struct sw_timer_module *const  module_inst)

Stop the timer.

Parameters
[in]module_instPointer of timer.

References Assert, tcc_disable(), and sw_timer_module::tcc_inst.

void sw_timer_disable_callback ( struct sw_timer_module *const  module_inst,
int  timer_id 
)

Disable callback.

Disable the callback function registered by the sw_timer_register_callback.

Parameters
[in]module_instPointer to USART software instance struct
[in]timer_idTimer ID .

References Assert, sw_timer_handle::callback_enable, and sw_timer_module::handler.

Referenced by _http_client_recved_packet().

void sw_timer_enable ( struct sw_timer_module *const  module_inst)

Start the timer.

Parameters
[in]module_instPointer of timer.

References Assert, tcc_enable(), and sw_timer_module::tcc_inst.

Referenced by _exosite_example_configure_timer(), and configure_timer().

void sw_timer_enable_callback ( struct sw_timer_module *const  module_inst,
int  timer_id,
uint32_t  delay 
)

Enables callback.

Enables the callback function registered by the sw_timer_register_callback.

Parameters
[in]module_instPointer to USART software instance struct
[in]timer_idTimer ID .
[in]delayInitialization value of timer.

References sw_timer_module::accuracy, Assert, sw_timer_handle::callback_enable, sw_timer_handle::expire_time, sw_timer_module::handler, and sw_timer_tick.

Referenced by http_client_socket_event_handler().

void sw_timer_get_config_defaults ( struct sw_timer_config *const  config)

Get default configuration of SW timer.

Parameters
[in]configPointer of configuration structure which will be used in the timer.

Get default configuration of SW timer.

This function performs to the increasing the tick count.

Parameters
[in]moduleInstance of the TCC.
[in]configPointer of configuration structure which will be used in the timer.

Get default configuration of SW timer.

This function performs to the increasing the tick count.

Parameters
[in]moduleInstance of the TCC.

References sw_timer_config::accuracy, Assert, sw_timer_config::tcc_callback_channel, and sw_timer_config::tcc_dev.

Referenced by _exosite_example_configure_timer(), and configure_timer().

int sw_timer_register_callback ( struct sw_timer_module *const  module_inst,
sw_timer_callback_t  callback,
void *  context,
uint32_t  period 
)

Register callback.

Parameters
[in]module_instPointer of timer.
[in]callbackCallback entry of time out.
[in]contextPrivate data of timer.
[in]periodPeriod of timer.
Returns
If negative value, registering timer was failed. Otherwise this value is ID of timer.

References sw_timer_module::accuracy, Assert, sw_timer_handle::callback, callback, sw_timer_handle::callback_enable, sw_timer_handle::context, context, sw_timer_module::handler, sw_timer_handle::period, and sw_timer_handle::used.

Referenced by http_client_init().

void sw_timer_task ( struct sw_timer_module *const  module_inst)

Checks the time out of each timer handlers.

This function must be called continuously for the checking the expiration of the timer handle.

Parameters
[in]module_instPointer to USART software instance struct

References Assert, sw_timer_handle::busy, sw_timer_handle::callback, sw_timer_handle::callback_enable, sw_timer_handle::context, sw_timer_handle::expire_time, sw_timer_module::handler, sw_timer_handle::period, sw_timer_tick, and sw_timer_handle::used.

Referenced by _http_client_send_wait(), and main().

void sw_timer_unregister_callback ( struct sw_timer_module *const  module_inst,
int  timer_id 
)

Unregister callback.

Parameters
[in]module_instPointer of timer.
[in]timer_idTimer ID .

References Assert, sw_timer_module::handler, and sw_timer_handle::used.