restore_to_hal.h File Reference

Go to the source code of this file.

Functions
void	rth_init (void)
void	rth_cleanup (void)
void	rth_schedule_enable (const char *const object)
void	rth_disable (const char *const object)

Detailed Description

Functionality related to enabling objects towards the HAL at startup if they are enabled according to the persistent settings.

The only read-write Enable fields in the BBF XPON DM are:

• XPON.ONU.{i}.Enable and
• XPON.ONU.{i}.ANI.{i}.Enable

This plugin calls rth_schedule_enable() for each such parameter which is true according to the persistent settings. The restore_to_hal part then enables the object in the HAL.

Definition in file restore_to_hal.h.

Function Documentation

rth_cleanup()

void rth_cleanup

(

void

)

Definition at line 234 of file restore_to_hal.c.

                       {
    if(!amxc_llist_is_empty(&s_rth_tasks)) {
        /* Normally s_rth_tasks should be empty upon stopping */
        SAH_TRACEZ_WARNING(ME, "size(s_rth_tasks)=%zd != 0",
                           amxc_llist_size(&s_rth_tasks));
        amxc_llist_clean(&s_rth_tasks, rth_task_delete);
    }
    amxp_timer_delete(&s_timer_handle_rth_tasks);
}

Here is the call graph for this function:

Here is the caller graph for this function:

rth_disable()

void rth_disable

(

const char *const

object

)

Remove task to enable an object in the HAL if such task exists.

Parameters

[in]

object

object path, e.g. "XPON.ONU.1"

Definition at line 286 of file restore_to_hal.c.

                                           {
    if(amxc_llist_is_empty(&s_rth_tasks)) {
        return;
    }
    rth_task_t* task;
    const char* path;
    amxc_llist_for_each(it, &s_rth_tasks) {
        task = amxc_llist_it_get_data(it, rth_task_t, it);
        path = amxc_string_get(&task->path, 0);
        if(strcmp(object, path) == 0) {
            amxc_llist_it_take(it);
            rth_task_delete(it);
            break; /* out of iteration over s_rth_tasks */
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

rth_init()

void rth_init

(

void

)

Definition at line 226 of file restore_to_hal.c.

                    {
    amxc_llist_init(&s_rth_tasks);
 
    if(amxp_timer_new(&s_timer_handle_rth_tasks, handle_rth_tasks, NULL)) {
        SAH_TRACEZ_ERROR(ME, "Failed to create timer to handle tasks");
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

rth_schedule_enable()

void rth_schedule_enable

(

const char *const

object

)

Schedule task to enable an object in the HAL.

Parameters

[in]

object

object path, e.g. "XPON.ONU.1"

The function creates a task to enable the object in the HAL, appends it to the list of tasks managed by this restore_to_hal part, and starts the timer to handle all tasks in that list.

If there is already a task in the list to enable the object, the function immediately returns.

Definition at line 256 of file restore_to_hal.c.

                                                   {
 
    SAH_TRACEZ_DEBUG(ME, "object='%s'", object);
 
    when_null_trace(s_timer_handle_rth_tasks, exit, ERROR, "No timer");
 
    const rth_task_t* task;
    const char* path;
    amxc_llist_iterate(it, &s_rth_tasks) {
        task = amxc_llist_it_get_data(it, rth_task_t, it);
        path = amxc_string_get(&task->path, 0);
        if(strncmp(path, object, strlen(object)) == 0) {
            SAH_TRACEZ_DEBUG(ME, "%s is already scheduled to be enabled", object);
            return;
        }
    }
 
    if(rth_task_create(object) != NULL) {
        amxp_timer_start(s_timer_handle_rth_tasks, SHORT_TIMEOUT_MS);
    }
 
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function: