Cosmetic changes to microkernel timer type definition

Revises comments to make it clear that the timer structure and
its fields are not part of the public API. Also eliminates an
unnecessary forward reference issue by defining the linked list
fields of the timer structure using the structure name itself.

Change-Id: Ic6489c38ab4e3a6408a0b9475bdd2956ae51c4a4
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
This commit is contained in:
Allan Stephens 2015-05-06 13:24:37 -04:00 committed by Anas Nashif
commit 4f96620e09

View file

@ -44,17 +44,19 @@ extern "C" {
typedef union k_args_args K_ARGS_ARGS;
struct k_timer;
typedef struct k_timer K_TIMER;
/* Kernel timer structure (non-public) */
struct k_timer { /* For pointer declarations only !! */
/* Do not access fields in user code. */
K_TIMER *Forw;
K_TIMER *Back;
struct k_timer {
struct k_timer *Forw;
struct k_timer *Back;
int32_t duration;
int32_t period;
struct k_args *Args;
}; /* use K_TIMER as the timer type name */
};
/* Kernel timer type (public) */
typedef struct k_timer K_TIMER;
/* ---------------------------------------------------------------------- */
/* PROCESSOR SPECIFIC TYPES & DATA STRUCTURES */