bootup.h File Reference


Detailed Description

Prototypes for calling the Netzer application boot up and network routines.

Software License
See the MBCSL for details.
Author:
Sven Schlender (kontakt at mobacon dot de)
Date:
2008-09-26


Data Structures

struct  _IP_CONFIG
 This typedef defines the local structure for TCP/IP stack parameters. More...
struct  CommonConfig_t
 This typedef defines the peristent structure for common settings and TCP/IP stack parameters. More...

Defines

#define MAX_NETWORKNAME_LENGTH   8
 The maximum allowed length for network names (currently used in the MDNS).

Enumerations

enum  IPSelectionModes_t {
  IPS_DHCP_ENABLED = 0, IPS_DHCP_AUTOIP, IPS_DHCP_MANUALIP, IPS_AUTO_IP,
  IPS_MANUAL_IP, IPS_MODE_COUNT
}
 This typedef defines the various modes how the Netzer gets its IP address. More...
enum  IPObtainedFrom_t { IPO_DHCP = 0, IPO_AUTO, IPO_MANUAL }
 This enumerator states from which instance the current device IP was obtained from. More...
enum  NetzerProjects_t
 Enumerates the different targets a Netzer can be used for. More...
enum  IPField_t {
  VAR_IP_ADDRESS = 0, VAR_GATEWAY_ADDRESS, VAR_SUBNET_MASK, VAR_MAN_IP_ADDRESS,
  VAR_MAN_SUBNET_MASK, VAR_MAN_GATEWAY_ADDRESS, VAR_IP_ADDRESS_EEPROM, VAR_SUBNET_MASK_EEPROM,
  VAR_GATEWAY_ADDRESS_EEPROM
}
 Use this enumerator for the function BootupPrintIPAddress to get a well formated IP address. More...

Functions

void BootupInit (void)
 This function initializes the application network module.
BOOL BootupMain (void)
 This function must be called periodically by the application.
void BootupResetToFactory (void)
 Sometimes the reset of the persistent data in the EEPROM to a well known state is needed.
void BootupEnterBootloader (void)
 Calling this function prepares the bootloader entry.
void BootupBlink (void)
 This function blinks the network LED with a second period.
void BootupGetNetworkName (BOOL Persistent, BYTE *pNameBuffer, BYTE SizeOfBuffer)
 Delivers the network name of the device.
void BootupPrintIPAddress (IPField_t Position, BYTE *pBuffer)
 Use this function to generate a string from a IP address of this device.
void BootupPrintFormatedIPAddress (BYTE *pIPAddress, BYTE *pBuffer)
 Use this function to print a formated IP address to a given RAM buffer.
BOOL BootupSetIPAddress (IPField_t Position, BYTE *pIPString)
 Use this function to change the given IP address with an IP address string.
void BootupSetNetworkName (BYTE *pName)
 Use this function to change the network name of the device.
IPSelectionModes_t BootupGetIPMode (BOOL LoadFromPersistent)
 Delivers the current selected Netzer IP mode.
void BootupSetHTTPPort (WORD NewPort)
 Set a new port for the HTTP service for the next session (after reboot).
WORD BootupGetHTTPPort (BOOL LoadFromPersistent)
 Delivers the currently set or persistently written port value for the HTTP service.
void BootupGetIPAddress (IPField_t Position, BYTE *pBuffer)
 Use this function to obtain any of the device IP addresses.
void BootupInvalidateIPSettings (void)
 Reset the current IP settings to invalid.

Variables

IPConfig_t sIPConfig
 This field stores the local TCP/IP parameters.
CommonConfig_t sPCommonConfig
 The persitent data field.


Generated on Fri Mar 29 10:34:27 2013 for Netzer by  doxygen 1.5.5