ethernet.h File Reference

#include "supervisor.h"
#include "shell.h"

Functions
eExecStatus	e_ethernet_cmd_get_config (eModId xModId, signed short FsNavId, int ac, signed portCHAR *av[], signed portCHAR **ppcStringReply)
	The set sensor config command: set the value of a config field of a sensor. Takes three parameters. The first parameter is the sensor's name, the second parameter is the config field name, the third parameter is the value. Format: set_sensor_config sensorname field=value. More...
eExecStatus	e_ethernet_cmd_set_config (eModId xModId, signed short FsNavId, int ac, signed portCHAR *av[], signed portCHAR **ppcStringReply)
	The get sensor config command: get the config fields value of a sensor. Takes one parameter, that is the sensor's name. Format: get_sensor_config sensorname. More...
eExecStatus	e_ip_stat (eModId xModId, signed short FsNavId, int ac, signed portCHAR *av[], signed portCHAR **ppcStringReply)
	The development only ip statck stats: display the TCP/IP stack stats on COM2. No parameters. Format: ipstat. More...
	portTASK_FUNCTION (vStartEthernetTask, pvParameters)
	configure lwIP and MACB, start lwIP layer, start servers tasks through lwIP services. More...
void	v_ethernet_stopResources (void)
	Stop the Ethernet module resources. More...
void	vEthernetGetGWAddr (portCHAR *pcConfig)
	get the current GW address : formatted as follow : XXX.XXX.XXX.XXX More...
void	vEthernetGetIPAddr (portCHAR *pcConfig)
	get the current IP address : formatted as follow : XXX.XXX.XXX.XXX More...
void	vEthernetGetMACAddr (portCHAR *pcConfig)
	get the current MAC address : formatted as follow : XX:XX:XX:XX:XX:XX More...
void	vEthernetGetSubnetMask (portCHAR *pcConfig)
	get the current Subnet mask : formatted as follow : XXX.XXX.XXX.XXX More...
void	vStartEthernetTaskLauncher (unsigned portBASE_TYPE uxPriority)
	Create the vStartEthernetTask task. More...

eExecStatus e_ethernet_cmd_get_config	(	eModId	xModId,
		signed short	FsNavId,
		int	ac,
		signed portCHAR *	av[],
		signed portCHAR **	ppcStringReply
	)

The set sensor config command: set the value of a config field of a sensor. Takes three parameters. The first parameter is the sensor's name, the second parameter is the config field name, the third parameter is the value. Format: set_sensor_config sensorname field=value.

Note

This function must be of the type pfShellCmd defined by the shell module.

Parameters

xModId	Input. The module that is calling this function.
FsNavId	Ignored.
ac	Input. The argument counter. For this command, should be 3.
av	Input. The argument vector.
ppcStringReply	Input/Output. The response string. If Input is NULL, no response string will be output. Else a malloc for the response string is performed here; the caller must free this string.

Returns

the status of the command execution.

References NULL, pvPortMalloc(), SHELL_ERRMSG_MEMALLOC, SHELL_EXECSTATUS_KO, SHELL_EXECSTATUS_OK, vEthernetGetGWAddr(), vEthernetGetIPAddr(), vEthernetGetMACAddr(), and vEthernetGetSubnetMask().

Referenced by e_syscmds_cmd_get_config().

eExecStatus e_ethernet_cmd_set_config	(	eModId	xModId,
		signed short	FsNavId,
		int	ac,
		signed portCHAR *	av[],
		signed portCHAR **	ppcStringReply
	)

The get sensor config command: get the config fields value of a sensor. Takes one parameter, that is the sensor's name. Format: get_sensor_config sensorname.

Note

This function must be of the type pfShellCmd defined by the shell module.

Parameters

xModId	Input. The module that is calling this function.
FsNavId	Ignored.
ac	Input. The argument counter. For this command, should be 1.
av	Input. The argument vector.
ppcStringReply	Input/Output. The response string. If Input is NULL, no response string will be output. Else a malloc for the response string is performed here; the caller must free this string.

Returns

the status of the command execution.

References config_file_set_value(), ETHERNET_CONFIG_FILE, NULL, pvPortMalloc(), SHELL_ERRMSG_CONFIGERROR, SHELL_EXECSTATUS_KO, SHELL_EXECSTATUS_OK, and SHELL_MSG_REBOOT.

Referenced by e_syscmds_cmd_set_config().

eExecStatus e_ip_stat	(	eModId	xModId,
		signed short	FsNavId,
		int	ac,
		signed portCHAR *	av[],
		signed portCHAR **	ppcStringReply
	)

The development only ip statck stats: display the TCP/IP stack stats on COM2. No parameters. Format: ipstat.

Note

This function must be of the type pfShellCmd defined by the shell module.

Parameters

xModId	Input. The module that is calling this function.
FsNavId	Ignored.
ac	Input. The argument counter. Ignored.
av	Input. The argument vector. Ignored
ppcStringReply	Input/Output. The response string. If Input is NULL, no response string will be output. Else a malloc for the response string is performed here; the caller must free this string.

Returns

the status of the command execution.

References NULL, SHELL_EXECSTATUS_OK, and stats_display().

portTASK_FUNCTION	(	vStartEthernetTask	,
		pvParameters
	)

configure lwIP and MACB, start lwIP layer, start servers tasks through lwIP services.

References CTRLPANEL_SMTP_CLIENT_PRIORITY, CTRLPANEL_SMTP_CLIENT_STACK_SIZE, CTRLPANEL_TFTP_SERVER_PRIORITY, CTRLPANEL_TFTP_SERVER_STACK_SIZE, CTRLPANEL_WEB_SERVER_PRIORITY, CTRLPANEL_WEB_SERVER_STACK_SIZE, EXTPHY_MACB_MDC_FUNCTION, EXTPHY_MACB_MDC_PIN, EXTPHY_MACB_MDIO_FUNCTION, EXTPHY_MACB_MDIO_PIN, EXTPHY_MACB_RX_DV_FUNCTION, EXTPHY_MACB_RX_DV_PIN, EXTPHY_MACB_RX_ER_FUNCTION, EXTPHY_MACB_RX_ER_PIN, EXTPHY_MACB_RXD_0_FUNCTION, EXTPHY_MACB_RXD_0_PIN, EXTPHY_MACB_RXD_1_FUNCTION, EXTPHY_MACB_RXD_1_PIN, EXTPHY_MACB_TX_CLK_FUNCTION, EXTPHY_MACB_TX_CLK_PIN, EXTPHY_MACB_TX_EN_FUNCTION, EXTPHY_MACB_TX_EN_PIN, EXTPHY_MACB_TXD_0_FUNCTION, EXTPHY_MACB_TXD_0_PIN, EXTPHY_MACB_TXD_1_FUNCTION, EXTPHY_MACB_TXD_1_PIN, gpio_enable_module(), NULL, prvlwIPInit(), sys_thread_new(), and vTaskDelete().

void v_ethernet_stopResources

(

void

)

Stop the Ethernet module resources.

References vDisableMACBOperations().

Referenced by e_syscmds_reboot().

void vEthernetGetGWAddr

(

portCHAR *

pcConfig

)

get the current GW address : formatted as follow : XXX.XXX.XXX.XXX

Parameters

pcConfig

Input/Output. The response string. If Input is NULL, no response string will be output. The caller has to allocate this buffer

References netif::gw, MACB_if, ntohl, NULL, and sprintf().

Referenced by e_ethernet_cmd_get_config().

void vEthernetGetIPAddr

(

portCHAR *

pcConfig

)

get the current IP address : formatted as follow : XXX.XXX.XXX.XXX

Parameters

pcConfig

Input/Output. The response string. If Input is NULL, no response string will be output. The caller has to allocate this buffer

References netif::ip_addr, MACB_if, ntohl, NULL, and sprintf().

Referenced by e_ethernet_cmd_get_config(), prulweb_BuildErrorTail(), and prvEthernetConfigureInterface().

void vEthernetGetMACAddr

(

portCHAR *

pcConfig

)

get the current MAC address : formatted as follow : XX:XX:XX:XX:XX:XX

Parameters

pcConfig

Input/Output. The response string. If Input is NULL, no response string will be output. The caller has to allocate this buffer

References netif::hwaddr, MACB_if, NULL, and sprintf().

Referenced by e_ethernet_cmd_get_config().

void vEthernetGetSubnetMask

(

portCHAR *

pcConfig

)

get the current Subnet mask : formatted as follow : XXX.XXX.XXX.XXX

Parameters

pcConfig

Input/Output. The response string. If Input is NULL, no response string will be output. The caller has to allocate this buffer

References MACB_if, netif::netmask, ntohl, NULL, and sprintf().

Referenced by e_ethernet_cmd_get_config().

void vStartEthernetTaskLauncher

(

unsigned portBASE_TYPE

uxPriority

)

Create the vStartEthernetTask task.

References configMINIMAL_STACK_SIZE, NULL, and xTaskCreate.

Referenced by portTASK_FUNCTION().