Detailed Description

Functions
static enum mmagic_status	mmagic_controller_get_ip_ip_addr (struct mmagic_controller controller, struct struct_ip_addr var)
	Gets `ip_addr` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_set_ip_ip_addr (struct mmagic_controller controller, struct struct_ip_addr var)
	Sets `ip_addr` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_get_ip_netmask (struct mmagic_controller controller, struct struct_ip_addr var)
	Gets `netmask` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_set_ip_netmask (struct mmagic_controller controller, struct struct_ip_addr var)
	Sets `netmask` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_get_ip_gateway (struct mmagic_controller controller, struct struct_ip_addr var)
	Gets `gateway` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_set_ip_gateway (struct mmagic_controller controller, struct struct_ip_addr var)
	Sets `gateway` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_get_ip_dns_server0 (struct mmagic_controller controller, struct struct_ip_addr var)
	Gets `dns_server0` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_set_ip_dns_server0 (struct mmagic_controller controller, struct struct_ip_addr var)
	Sets `dns_server0` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_get_ip_dns_server1 (struct mmagic_controller controller, struct struct_ip_addr var)
	Gets `dns_server1` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_set_ip_dns_server1 (struct mmagic_controller controller, struct struct_ip_addr var)
	Sets `dns_server1` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_get_ip_dhcp_enabled (struct mmagic_controller controller, bool var)
	Gets `dhcp_enabled` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_set_ip_dhcp_enabled (struct mmagic_controller *controller, bool var)
	Sets `dhcp_enabled` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_get_ip_dhcp_offload (struct mmagic_controller controller, bool var)
	Gets `dhcp_offload` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_set_ip_dhcp_offload (struct mmagic_controller *controller, bool var)
	Sets `dhcp_offload` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_get_ip_link_status_evt_en (struct mmagic_controller controller, bool var)
	Gets `link_status_evt_en` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_set_ip_link_status_evt_en (struct mmagic_controller *controller, bool var)
	Sets `link_status_evt_en` setting for module `ip`. More...

static enum mmagic_status	mmagic_controller_ip_commit_all (struct mmagic_controller *controller)
	Saves all settings from persistent store. More...

Function Documentation

◆ mmagic_controller_get_ip_dhcp_enabled()

static enum mmagic_status mmagic_controller_get_ip_dhcp_enabled	(	struct mmagic_controller *	controller,
		bool *	var
	)

inlinestatic

Gets dhcp_enabled setting for module ip.

True to enable DHCP for IP address configuration, or false to use the static configuration given by ip_addr, netmask, and gateway. This will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	Reference to the `bool` to place the received data in.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3695 of file mmagic_controller.h.

◆ mmagic_controller_get_ip_dhcp_offload()

static enum mmagic_status mmagic_controller_get_ip_dhcp_offload	(	struct mmagic_controller *	controller,
		bool *	var
	)

inlinestatic

Gets dhcp_offload setting for module ip.

If true, enables DHCP offload which allows the Morse chip to directly handle DHCP discovery and leases without waking up the host processor. Note: this comes into effect only if ip.dhcp_enabled is also true.

Parameters

controller	Reference to the controller handle.
var	Reference to the `bool` to place the received data in.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3751 of file mmagic_controller.h.

◆ mmagic_controller_get_ip_dns_server0()

static enum mmagic_status mmagic_controller_get_ip_dns_server0	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Gets dns_server0 setting for module ip.

Primary DNS server IP address. If a value is specified this will override the primary DNS server provided by DHCP (if any). Changes will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to place the received data in.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3583 of file mmagic_controller.h.

◆ mmagic_controller_get_ip_dns_server1()

static enum mmagic_status mmagic_controller_get_ip_dns_server1	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Gets dns_server1 setting for module ip.

Secondary DNS server IP address. If a value is specified this will override the secondary DNS server provided by DHCP (if any). Changes will take effect when the reload command is successfully executed. Note that this option may be ignored by some IP stacks.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to place the received data in.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3639 of file mmagic_controller.h.

◆ mmagic_controller_get_ip_gateway()

static enum mmagic_status mmagic_controller_get_ip_gateway	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Gets gateway setting for module ip.

Gateway to use for a static network connection. This will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to place the received data in.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3528 of file mmagic_controller.h.

◆ mmagic_controller_get_ip_ip_addr()

static enum mmagic_status mmagic_controller_get_ip_ip_addr	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Gets ip_addr setting for module ip.

IP address to use for a static network connection. This will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to place the received data in.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3420 of file mmagic_controller.h.

◆ mmagic_controller_get_ip_link_status_evt_en()

static enum mmagic_status mmagic_controller_get_ip_link_status_evt_en	(	struct mmagic_controller *	controller,
		bool *	var
	)

inlinestatic

Gets link_status_evt_en setting for module ip.

When set to true, IP link status notifications will be provided. Setting this to false will suppress these notifications. Defaults to true.

Parameters

controller	Reference to the controller handle.
var	Reference to the `bool` to place the received data in.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3806 of file mmagic_controller.h.

◆ mmagic_controller_get_ip_netmask()

static enum mmagic_status mmagic_controller_get_ip_netmask	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Gets netmask setting for module ip.

Netmask to use for a static network connection. This will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to place the received data in.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3474 of file mmagic_controller.h.

◆ mmagic_controller_ip_commit_all()

static enum mmagic_status mmagic_controller_ip_commit_all ( struct mmagic_controller * controller )

inlinestatic

Saves all settings from persistent store.

Parameters

controller Reference to the controller handle.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3856 of file mmagic_controller.h.

◆ mmagic_controller_set_ip_dhcp_enabled()

static enum mmagic_status mmagic_controller_set_ip_dhcp_enabled	(	struct mmagic_controller *	controller,
		bool	var
	)

inlinestatic

Sets dhcp_enabled setting for module ip.

True to enable DHCP for IP address configuration, or false to use the static configuration given by ip_addr, netmask, and gateway. This will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	The `bool` to write.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3723 of file mmagic_controller.h.

◆ mmagic_controller_set_ip_dhcp_offload()

static enum mmagic_status mmagic_controller_set_ip_dhcp_offload	(	struct mmagic_controller *	controller,
		bool	var
	)

inlinestatic

Sets dhcp_offload setting for module ip.

If true, enables DHCP offload which allows the Morse chip to directly handle DHCP discovery and leases without waking up the host processor. Note: this comes into effect only if ip.dhcp_enabled is also true.

Parameters

controller	Reference to the controller handle.
var	The `bool` to write.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3779 of file mmagic_controller.h.

◆ mmagic_controller_set_ip_dns_server0()

static enum mmagic_status mmagic_controller_set_ip_dns_server0	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Sets dns_server0 setting for module ip.

Primary DNS server IP address. If a value is specified this will override the primary DNS server provided by DHCP (if any). Changes will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to write.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3611 of file mmagic_controller.h.

◆ mmagic_controller_set_ip_dns_server1()

static enum mmagic_status mmagic_controller_set_ip_dns_server1	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Sets dns_server1 setting for module ip.

Secondary DNS server IP address. If a value is specified this will override the secondary DNS server provided by DHCP (if any). Changes will take effect when the reload command is successfully executed. Note that this option may be ignored by some IP stacks.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to write.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3667 of file mmagic_controller.h.

◆ mmagic_controller_set_ip_gateway()

static enum mmagic_status mmagic_controller_set_ip_gateway	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Sets gateway setting for module ip.

Gateway to use for a static network connection. This will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to write.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3555 of file mmagic_controller.h.

◆ mmagic_controller_set_ip_ip_addr()

static enum mmagic_status mmagic_controller_set_ip_ip_addr	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Sets ip_addr setting for module ip.

IP address to use for a static network connection. This will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to write.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3447 of file mmagic_controller.h.

◆ mmagic_controller_set_ip_link_status_evt_en()

static enum mmagic_status mmagic_controller_set_ip_link_status_evt_en	(	struct mmagic_controller *	controller,
		bool	var
	)

inlinestatic

Sets link_status_evt_en setting for module ip.

When set to true, IP link status notifications will be provided. Setting this to false will suppress these notifications. Defaults to true.

Parameters

controller	Reference to the controller handle.
var	The `bool` to write.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3833 of file mmagic_controller.h.

◆ mmagic_controller_set_ip_netmask()

static enum mmagic_status mmagic_controller_set_ip_netmask	(	struct mmagic_controller *	controller,
		struct struct_ip_addr *	var
	)

inlinestatic

Sets netmask setting for module ip.

Netmask to use for a static network connection. This will take effect when the reload command is successfully executed.

Parameters

controller	Reference to the controller handle.
var	Reference to the `struct_ip_addr` to write.

Returns: MMAGIC_STATUS_OK on success, else an error code.

Definition at line 3501 of file mmagic_controller.h.

Detailed Description

Functions

Function Documentation

◆ mmagic_controller_get_ip_dhcp_enabled()

◆ mmagic_controller_get_ip_dhcp_offload()

◆ mmagic_controller_get_ip_dns_server0()

◆ mmagic_controller_get_ip_dns_server1()

◆ mmagic_controller_get_ip_gateway()

◆ mmagic_controller_get_ip_ip_addr()

◆ mmagic_controller_get_ip_link_status_evt_en()

◆ mmagic_controller_get_ip_netmask()

◆ mmagic_controller_ip_commit_all()

◆ mmagic_controller_set_ip_dhcp_enabled()

◆ mmagic_controller_set_ip_dhcp_offload()

◆ mmagic_controller_set_ip_dns_server0()

◆ mmagic_controller_set_ip_dns_server1()

◆ mmagic_controller_set_ip_gateway()

◆ mmagic_controller_set_ip_ip_addr()

◆ mmagic_controller_set_ip_link_status_evt_en()

◆ mmagic_controller_set_ip_netmask()