| Cyg_Counter::Cyg_Counter | |
| Name: | Cyg_Counter::Cyg_Counter ( ) - create a counter |
|---|---|
| Synopsis: | Cyg_Counter::Cyg_Counter ( cyg_uint32 increment=1 /* number of ticks to increment counter by */ ) |
| Description: | This creates a new counter. Counters can increment any arbitrary amount but usually only by 1. The value of the counter is always initialized to 0. Counters are 64 bit. |
| Include: | #include <cyg/kernel/clock.hxx> |
| Returns: | nothing |
| See Also: | Cyg_Counter::~Cyg_Counter |
| Cyg_Counter::~Cyg_Counter | |
| Name: | Cyg_Counter::~Cyg_Counter ( ) - destroys a counter |
|---|---|
| Synopsis: | Cyg_Counter::~Cyg_Counter ( void ) |
| Description: | This destroys a counter. |
| Include: | #include <cyg/kernel/clock.hxx> |
| Returns: | nothing |
| See Also: | Cyg_Counter::Cyg_Counter |
| Cyg_Counter::current_value | |
| Name: | Cyg_Counter::current_value ( ) - get the current value of the counter |
|---|---|
| Synopsis: | cyg_tick_count Cyg_Counter::current_value ( void ) |
| Description: | Gets the current value of the counter. |
| Include: | #include <cyg/kernel/clock.hxx>
#include <cyg/kernel/clock.inl> |
| Returns: | the current value of the counter. |
| See Also: | Cyg_Counter::current_value_lo, Cyg_Counter::current_value_hi, Cyg_Counter::set_value, Cyg_Counter::tick |
| Cyg_Counter::current_value_lo | |
| Name: | Cyg_Counter::current_value_lo ( ) - get lower 32 bits of counter |
|---|---|
| Synopsis: | cyg_uint32 Cyg_Counter::current_value_lo ( void ) |
| Description: | Gets the lower 32 bits of the current value of the counter. |
| Include: | #include <cyg/kernel/clock.hxx>
#include <cyg/kernel/clock.inl> |
| Returns: | the lower 32 bits of the current value of the counter. |
| See Also: | Cyg_Counter::current_value, Cyg_Counter::current_value_hi, Cyg_Counter::set_value, Cyg_Counter::tick |
| Cyg_Counter::current_value_hi | |
| Name: | Cyg_Counter::current_value_hi ( ) - get upper 32 bits of counter |
|---|---|
| Synopsis: | cyg_uint32 Cyg_Counter::current_value_hi ( void ) |
| Description: | Gets the upper 32 bits of the current value of the counter. |
| Include: | #include <cyg/kernel/clock.hxx>
#include <cyg/kernel/clock.inl> |
| Returns: | the upper 32 bits of the current value of the counter. |
| See Also: | Cyg_Counter::current_value, Cyg_Counter::current_value_lo, Cyg_Counter::set_value, Cyg_Counter::tick |
| Cyg_Counter::set_value | |
| Name: | Cyg_Counter::set_value ( ) - set counter value directly |
|---|---|
| Synopsis: | void Cyg_Counter::set_value ( cyg_tick_count new_value /* new value of counter */ ) |
| Description: | Sets the value of the counter. Note that the value is a 64 bit value not a 32 bit value. |
| Include: | #include <cyg/kernel/clock.hxx>
#include <cyg/kernel/clock.inl> |
| Returns: | nothing |
| See Also: | Cyg_Counter::current_value, Cyg_Counter::current_value_lo, Cyg_Counter::current_value_hi, Cyg_Counter::tick |
| Cyg_Counter::tick | |
| Name: | Cyg_Counter::tick ( ) - increment counter by some number of ticks |
|---|---|
| Synopsis: | void Cyg_Counter::tick ( cyg_uint32 ticks=1 /* number of ticks to increment counter */ ) |
| Description: | Increments the counter by some number of ticks. Doing this can trigger alarms that are attached to this counter if the alarms have expired. |
| Include: | #include <cyg/kernel/clock.hxx> |
| Returns: | nothing |
| See Also: | Cyg_Counter::current_value, Cyg_Counter::current_value_lo, Cyg_Counter::current_value_hi, Cyg_Counter::set_value |
| Cyg_Counter::add_alarm | |
| Name: | Cyg_Counter::add_alarm ( ) - attach an alarm to counter |
|---|---|
| Synopsis: | void Cyg_Counter::add_alarm ( Cyg_Alarm *alarm /* alarm to attach to counter */ ) |
| Description: | This attaches an alarm to the counter. |
| Include: | #include <cyg/kernel/clock.hxx> |
| Returns: | nothing |
| See Also: | Cyg_Counter::tick, Cyg_Counter::rem_alarm |
| Cyg_Counter::rem_alarm | |
| Name: | Cyg_Counter::rem_alarm ( ) - detach alarm from counter |
|---|---|
| Synopsis: | void Cyg_Counter::rem_alarm ( Cyg_Alarm *alarm /* alarm to remove from counter */ ) |
| Description: | This detaches an alarm from a counter |
| Include: | #include <cyg/kernel/clock.hxx> |
| Returns: | nothing |
| See Also: | Cyg_Counter::tick, Cyg_Counter::add_alarm |