pon_ctrl.h File Reference

#include <stdbool.h>
#include <amxc/amxc_variant.h>

Go to the source code of this file.

Functions
void	pon_ctrl_init (void)
void	pon_ctrl_set_enable (const char *const path, bool enable)
int	pon_ctrl_get_list_of_instances (const char *const path, amxc_var_t *ret)
int	pon_ctrl_get_object_content (const char *const path, uint32_t index, amxc_var_t *ret)
int	pon_ctrl_get_param_values (const char *const path, const char *const names, amxc_var_t *ret)
void	pon_ctrl_handle_file_descriptor (int fd)
void	pon_ctrl_set_password (const char *const ani_path, const char *const password, bool hex)

Detailed Description

Functionality related to calling functions in the 'pon_ctrl' namespace registered by the vendor module.

Definition in file pon_ctrl.h.

Function Documentation

pon_ctrl_get_list_of_instances()

int pon_ctrl_get_list_of_instances	(	const char *const	path,
		amxc_var_t *	ret
	)

Ask vendor module which instances exist for a template object.

Parameters

[in]	path	path to template object, e.g. "XPON.ONU" or "XPON.ONU.1.SoftwareImage"
[in,out]	ret	function returns result via this parameter. See below for more info.

The param ret should be an htable with following keys upon success:

• 'indexes': a string with comma-separated integers representing the instance indexes. It's an empty string if no instances exist.

Returns

0 on success, -1 upon error

Definition at line 187 of file pon_ctrl.c.

                                                                            {
 
    amxc_var_t args;
    amxc_var_init(&args);
    amxc_var_set(cstring_t, &args, path);
 
    const int rc =
        call_pon_ctrl_function_common(GET_LIST_OF_INSTANCES, &args, ret);
 
    amxc_var_clean(&args);
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pon_ctrl_get_object_content()

int pon_ctrl_get_object_content	(	const char *const	path,
		uint32_t	index,
		amxc_var_t *	ret
	)

Ask vendor module for the content (parameter values) of an object.

Parameters

[in]	path	object path. This can be a singleton or template object.
[in]	index	instance index when querying the content of an instance. Must be 0 when querying a singleton.
[in,out]	ret	function returns result via this parameter. See below for more info.

The param ret should be an htable with following keys upon success:

• 'parameters': values for the parameters of the object
• 'keys': only present in ret when querying an instance. It should contain values for the keys of the template object.

Returns

0 on success, -1 upon error

Definition at line 216 of file pon_ctrl.c.

                                                                                         {
 
    amxc_var_t args;
    amxc_var_init(&args);
 
    amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
    amxc_var_add_key(cstring_t, &args, "path", path);
    if(index) {
        amxc_var_add_key(uint32_t, &args, "index", index);
    }
 
    const int rc = call_pon_ctrl_function_common(GET_OBJECT_CONTENT, &args, ret);
 
    amxc_var_clean(&args);
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pon_ctrl_get_param_values()

int pon_ctrl_get_param_values	(	const char *const	path,
		const char *const	names,
		amxc_var_t *	ret
	)

Ask vendor module for the values of one or more parameters of an object.

Parameters

[in]	path	object path of a singleton or an instance
[in]	names	parameter names formatted as a comma-separated list. The vendor module might support passing max 1 parameter name. Example: "RxPower".
[in,out]	ret	function returns result via this parameter. See below for more info.

The param ret should be an htable with following keys upon success:

• 'parameters': values for the requested parameter(s) of the object

Returns

0 on success, -1 upon error

Definition at line 248 of file pon_ctrl.c.

                                               {
 
    amxc_var_t args;
    amxc_var_init(&args);
 
    amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
    amxc_var_add_key(cstring_t, &args, "path", path);
    amxc_var_add_key(cstring_t, &args, "names", names);
 
    SAH_TRACEZ_DEBUG(ME, "path='%s' names='%s'", path, names);
    const int rc = call_pon_ctrl_function_common(GET_PARAM_VALUES, &args, ret);
 
    amxc_var_clean(&args);
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pon_ctrl_handle_file_descriptor()

void pon_ctrl_handle_file_descriptor

(

int

fd

)

Ask vendor module to handle (a message arriving on) a file descriptor.

Parameters

[in]

fd

the file descriptor to handle

Examples for the file descriptor:

• file descriptor of the socket the vendor module uses for IPC with the vendor specific PON/OMCI stack.
• file descriptor of a socket to monitor netlink messages from the kernel.
• ...

Definition at line 277 of file pon_ctrl.c.

                                             {
 
    amxc_var_t var;
    amxc_var_init(&var);
    amxc_var_set(fd_t, &var, fd);
    call_pon_ctrl_function_common(HANDLE_FILE_DESCRIPTOR, &var, NULL);
    amxc_var_clean(&var);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pon_ctrl_init()

void pon_ctrl_init

(

void

)

Initialize the pon_ctrl part of this plugin.

The function forwards value of MAX_NR_OF_ONUS to the vendor module.

The plugin must call this function once at startup, after loading the vendor module.

Definition at line 142 of file pon_ctrl.c.

                         {
    set_max_nr_of_onus();
}

Here is the call graph for this function:

Here is the caller graph for this function:

pon_ctrl_set_enable()

void pon_ctrl_set_enable	(	const char *const	path,
		bool	enable
	)

Let vendor module know that a read-write Enable field was changed.

Parameters

[in]	path	path of object whose Enable field was changed, e.g., "XPON.ONU.1", or "XPON.ONU.1.ANI.1"
[in]	enable	true if Enable field was set to true, else false

Definition at line 153 of file pon_ctrl.c.

                                                              {
 
    amxc_var_t args;
    amxc_var_init(&args);
 
    SAH_TRACEZ_DEBUG(ME, "path='%s' enable=%d", path, enable);
 
    amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
 
    amxc_var_add_key(cstring_t, &args, "path", path);
    amxc_var_add_key(bool, &args, "enable", enable);
 
    if(call_pon_ctrl_function_common(SET_ENABLE, &args, NULL)) {
        SAH_TRACEZ_ERROR(ME, "path='%s' enable=%d: %s() failed",
                         path, enable, SET_ENABLE);
    }
 
    amxc_var_clean(&args);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pon_ctrl_set_password()

void pon_ctrl_set_password	(	const char *const	ani_path,
		const char *const	password,
		bool	hex
	)

Ask vendor module to apply the password.

Parameters

[in]	ani_path	path to ANI instance, e.g. "XPON.ONU.1.ANI.1"
[in]	password	new value for the parameter Password of the ANI referred to by ani_path
[in]	hex	false if password is in ASCII format; true if password is in hexadecimal format

Definition at line 295 of file pon_ctrl.c.

                                     {
    amxc_var_t args;
    amxc_var_init(&args);
 
    amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
    amxc_var_add_key(cstring_t, &args, "ani_path", ani_path);
    amxc_var_add_key(cstring_t, &args, "password", password);
    amxc_var_add_key(bool, &args, "is_hexadecimal_password", hex);
 
    SAH_TRACEZ_DEBUG(ME, "ani_path='%s' password='%s' hex=%d", ani_path, password, hex);
    call_pon_ctrl_function_common(SET_PASSWORD, &args, NULL);
    amxc_var_clean(&args);
}

Here is the call graph for this function:

Here is the caller graph for this function: