dm_events.c File Reference

#include <amxc/amxc.h>
#include <amxc/amxc_macros.h>
#include "ani.h"
#include "object_intf_priv.h"
#include "password.h"
#include "persistency.h"
#include "pon_ctrl.h"
#include "restore_to_hal.h"
#include "xpon_trace.h"

Go to the source code of this file.

Functions
static int	isdot (int c)
static void	onu_or_ani_enable_changed (const amxc_var_t *const event_data, bool onu)
void	_onu_enable_changed (UNUSED const char *const event_name, const amxc_var_t *const event_data, UNUSED void *const priv)
void	_ani_enable_changed (UNUSED const char *const event_name, const amxc_var_t *const event_data, UNUSED void *const priv)
void	_interface_object_added (UNUSED const char *const event_name, const amxc_var_t *const event_data, UNUSED void *const priv)
void	_status_changed (UNUSED const char *const event_name, const amxc_var_t *const event_data, UNUSED void *const priv)
void	_password_changed (UNUSED const char *const event_name, const amxc_var_t *const event_data, UNUSED void *const priv)

Detailed Description

Handles functions called by the Ambiorix framework upon certain events triggered by changes to the XPON DM.

The file odl/tr181-xpon_definition.odl specifies which functions the Ambiorix framework should call upon certain events. E.g., the file specifies that Ambiorix should call the function

• onu_enable_changed() or
• ani_enable_changed() if the Enable parameter of an XPON.ONU or XPON.ONU.x.ANI instance is changed respectively.

Definition in file dm_events.c.

Function Documentation

_ani_enable_changed()

void _ani_enable_changed	(	UNUSED const char *const	event_name,
		const amxc_var_t *const	event_data,
		UNUSED void *const	priv
	)

The Enable param of an XPON.ONU.x.ANI instance changed value.

Parameters

[in]

event_data

has path and new value of the Enable param which changed value.

Definition at line 169 of file dm_events.c.

                                                  {
 
    onu_or_ani_enable_changed(event_data, /*onu=*/ false);
}

Here is the call graph for this function:

_interface_object_added()

void _interface_object_added	(	UNUSED const char *const	event_name,
		const amxc_var_t *const	event_data,
		UNUSED void *const	priv
	)

The component added an instance of an interface object.

Parameters

[in]

event_data

has path and index of instance added

The function attaches private data to the instance to support the LastChange parameter.

Definition at line 184 of file dm_events.c.

                                                      {
    oipriv_attach_private_data(event_data);
}

Here is the call graph for this function:

_onu_enable_changed()

void _onu_enable_changed	(	UNUSED const char *const	event_name,
		const amxc_var_t *const	event_data,
		UNUSED void *const	priv
	)

The Enable param of an XPON.ONU instance changed value.

Parameters

[in]

event_data

has path and new value of the Enable param which changed value.

Definition at line 156 of file dm_events.c.

                                                  {
 
    onu_or_ani_enable_changed(event_data, /*onu=*/ true);
}

Here is the call graph for this function:

_password_changed()

void _password_changed	(	UNUSED const char *const	event_name,
		const amxc_var_t *const	event_data,
		UNUSED void *const	priv
	)

The Password parameter of an ANI instance changed value.

Parameters

[in]

event_data

contains both the path of TC.Authentication object of the ANI instance whose Password parameter changed value, and the new value for that Password

The function does not need to check if the password is valid: _check_password() already did that.

The function (indirectly) forwards the value to:

• the vendor module
• the part of this plugin responsible for the upgrade persistent settings

Definition at line 219 of file dm_events.c.

                                                {
 
    amxc_string_t path_no_dot; /* path with dot at the end trimmed */
    amxc_string_t ani_instance;
    amxc_string_init(&path_no_dot, 0);
    amxc_string_init(&ani_instance, 0);
 
    const char* const path = GETP_CHAR(event_data, "path");
    const char* const password = GETP_CHAR(event_data, "parameters.Password.to");
 
    when_null_trace(path, exit, ERROR, "path is NULL");
    when_null_trace(password, exit, ERROR, "password is NULL");
 
    SAH_TRACEZ_DEBUG(ME, "path='%s' password='%s'", path, password);
 
    amxc_string_set(&path_no_dot, path);
    amxc_string_trimr(&path_no_dot, isdot);
 
    const char* const path_no_dot_cstr = amxc_string_get(&path_no_dot, 0);
 
    if(!ani_strip_tc_authentication(path_no_dot_cstr, &ani_instance)) {
        SAH_TRACEZ_ERROR(ME, "%s: failed to check password", path_no_dot_cstr);
        goto exit;
    }
 
    const char* const ani_instance_cstr = amxc_string_get(&ani_instance, 0);
    passwd_set_password(ani_instance_cstr, password);
 
exit:
    amxc_string_clean(&path_no_dot);
    amxc_string_clean(&ani_instance);
}

Here is the call graph for this function:

_status_changed()

void _status_changed	(	UNUSED const char *const	event_name,
		const amxc_var_t *const	event_data,
		UNUSED void *const	priv
	)

The Status parameter of an interface object changed value.

Parameters

[in]

event_data

has path of object whose Status parameter changed value

The function updates the 'last_change' timestamp in the private data attached to the object.

Definition at line 198 of file dm_events.c.

                                              {
 
    oipriv_update_last_change(event_data);
}

Here is the call graph for this function:

isdot()

static int isdot ( int  c )

static

Definition at line 91 of file dm_events.c.

                        {
    return (c == '.') ? 1 : 0;
}

Here is the caller graph for this function:

onu_or_ani_enable_changed()

static void onu_or_ani_enable_changed ( const amxc_var_t *const  event_data, bool  onu  )

static

The Enable param of an XPON.ONU or XPON.ONU.x.ANI instance changed value.

Parameters

[in]	event_data	has path and new value of the Enable param which changed value.
[in]	onu	If true, Enable of an ONU instance changed, else Enable of an ANI instance changed

The function forwards the value to:

• the vendor module
• the persistency part of this plugin

When enabling an ONU, avoid enabling the ONU while tr181-xpon is still busy querying whether the ONU has EthernetUNI and ANI instances. Schedule a task to enable the ONU in the near future.

restore_to_hal part maybe still has task to enable the object towards the hal. Remove that task if this function asks to disable the object.

Definition at line 107 of file dm_events.c.

                                                                                    {
 
    const char* const path = GETP_CHAR(event_data, "path");
    const bool enable = GETP_BOOL(event_data, "parameters.Enable.to");
 
    when_null_trace(path, exit, ERROR, "path is NULL");
 
    SAH_TRACEZ_INFO(ME, "path='%s' enable=%d", path, enable);
 
    amxc_string_t path_no_dot; /* path with dot at the end trimmed */
    amxc_string_init(&path_no_dot, 0);
    amxc_string_set(&path_no_dot, path);
    amxc_string_trimr(&path_no_dot, isdot);
 
    const char* const path_no_dot_cstr = amxc_string_get(&path_no_dot, 0);
 
    if(enable && onu) {
        rth_schedule_enable(path_no_dot_cstr);
    } else {
        pon_ctrl_set_enable(path_no_dot_cstr, enable);
    }
    persistency_enable(path_no_dot_cstr, enable);
 
    if(!enable) {
        rth_disable(path_no_dot_cstr);
    }
 
    amxc_string_clean(&path_no_dot);
 
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function: