|
|
| cyg_counter_create | |
| Name: | cyg_counter_create ( ) - create a new counter |
|---|---|
| Synopsis: | void cyg_counter_create ( cyg_handle_t *handle, /* returned counter handle */ cyg_counter *counter /* counter object */ ) |
| Description: | This creates a new counter. The new counter is returned through "handle". Counters have to be externally incremented before they can advance. |
| Include: | #include <cyg/kernel/kapi.h> |
| Returns: | nothing. |
| See Also: | cyg_counter_delete, cyg_counter_current_value, cyg_counter_set_value, cyg_counter_tick, cyg_counter_multi_tick |
| cyg_counter_delete | |
| Name: | cyg_counter_delete ( ) - delete a counter |
|---|---|
| Synopsis: | void cyg_counter_delete ( cyg_handle_t counter /* counter to delete */ ) |
| Description: | This deletes a counter. Be sure not to continue incrementing the counter once it's been deleted. |
| Include: | #include <cyg/kernel/kapi.h> |
| Returns: | nothing |
| See Also: | cyg_counter_create |
| cyg_counter_current_value | |
| Name: | cyg_counter_current_value ( ) - get current counter value |
|---|---|
| Synopsis: | cyg_tick_count_t cyg_counter_current_value ( cyg_handle_t counter /* counter to get the value of */ ) |
| Description: | This gets the specified counter's current value |
| Include: | #include <cyg/kernel/kapi.h> |
| Returns: | the number of ticks that has elapsed for this counter. |
| See Also: | cyg_counter_set_value, cyg_counter_tick, cyg_counter_multi_tick |
| cyg_counter_set_value | |
| Name: | cyg_counter_set_value ( ) - set the value of the counter |
|---|---|
| Synopsis: | void cyg_counter_set_value ( cyg_handle_t counter, /* counter to set */ cyg_tick_count_t new_value /* new value of counter */ ) |
| Description: | This sets the value of the specified counter to a new value. |
| Include: | #include <cyg/kernel/kapi.h> |
| Returns: | nothing |
| See Also: | cyg_counter_current_value, cyg_counter_tick, cyg_counter_multi_tick |
| cyg_counter_tick | |
| Name: | cyg_counter_tick ( ) - increment a counter by a single tick |
|---|---|
| Synopsis: | void cyg_counter_tick ( cyg_handle_t counter /* counter to advance */ ) |
| Description: | This increments a counter by a single tick. |
| Include: | #include <cyg/kernel/kapi.h> |
| Returns: | nothing |
| See Also: | cyg_counter_current_value, cyg_counter_set_value, cyg_counter_multi_tick |
| cyg_counter_multi_tick | |
| Name: | cyg_counter_multi_tick ( ) - advance a counter by multiple ticks |
|---|---|
| Synopsis: | void cyg_counter_multi_tick ( cyg_handle_t counter, /* counter to advance */ cyg_tick_count_t ticks /* number of ticks to advance */ ) |
| Description: | This increments a counter by a multiple number of ticks. |
| Include: | #include <cyg/kernel/kapi.h> |
| Returns: | nothing |
| See Also: | cyg_counter_current_value, cyg_counter_set_value, cyg_counter_tick |