platform/inc/stbhwip.h File Reference

macros and function prototypes for public use More...

Go to the source code of this file.

Functions
BOOLEAN	STB_IPGetIPAddress (U8BIT *ip_addr)
	Gets the current IPv4 address of the default IP connection.
BOOLEAN	STB_IPGetSubnetMask (U8BIT *subnet_mask)
	Gets the current IPv4 subnet mask of the default IP connection.
BOOLEAN	STB_IPGetGatewayIPAddress (U8BIT *gateway_addr)
	Gets the current IPv4 gateway IP address.
BOOLEAN	STB_IPGetDnsServerIPAddress (U8BIT *dns_addr)
	Gets the current IPv4 DNS server IP address.
void	STB_IPSetIPAddress (const U8BIT *ip_addr)
	Sets the IPv4 format IP address of default network connection.
void	STB_IPSetSubnetMask (const U8BIT *subnet_mask)
	Sets the IPv4 format subnet mask of default network connection.
void	STB_IPSetGatewayIPAddress (const U8BIT *gateway_addr)
	Sets the IPv4 format gateway IP address.
void	STB_IPSetDnsServerIPAddress (const U8BIT *dns_addr)
	Sets the IPv4 format DNS server IP address.
void	STB_IPGetIPByDhcp (BOOLEAN wait_for_completion)
	Cause the IP address to be set using DHCP.

---

Detailed Description

macros and function prototypes for public use

Date:

06/08/2009

---

Function Documentation

BOOLEAN STB_IPGetDnsServerIPAddress

(

U8BIT *

dns_addr

)

Gets the current IPv4 DNS server IP address.

Parameters:

dns_addr

4 byte array in which the address will be returned with the most significant byte in dns_addr[0]

Return values:

TRUE	if address is returned, FALSE otherwise

BOOLEAN STB_IPGetGatewayIPAddress

(

U8BIT *

gateway_addr

)

Gets the current IPv4 gateway IP address.

Parameters:

gateway_addr

4 byte array in which the address will be returned with the most significant byte in gateway_addr[0]

Return values:

TRUE	if address is returned, FALSE otherwise

BOOLEAN STB_IPGetIPAddress

(

U8BIT *

ip_addr

)

Gets the current IPv4 address of the default IP connection.

Parameters:

ip_addr

4 byte array in which the address will be returned with the most significant byte in ip_addr[0]

Return values:

TRUE	if address is returned, FALSE otherwise

void STB_IPGetIPByDhcp

(

BOOLEAN

wait_for_completion

)

Cause the IP address to be set using DHCP.

Parameters:

wait_for_completion

set as TRUE if the call shouldn't return until an IP address has been assigned or times out

BOOLEAN STB_IPGetSubnetMask

(

U8BIT *

subnet_mask

)

Gets the current IPv4 subnet mask of the default IP connection.

Parameters:

subnet_mask

4 byte array in which the address will be returned with the most significant byte in subnet_mask[0]

Return values:

TRUE	if address is returned, FALSE otherwise

void STB_IPSetDnsServerIPAddress

(

const U8BIT *

dns_addr

)

Sets the IPv4 format DNS server IP address.

Parameters:

dns_addr

4 byte array containing the mask to be set with the most significant byte in dns_addr[0]

void STB_IPSetGatewayIPAddress

(

const U8BIT *

gateway_addr

)

Sets the IPv4 format gateway IP address.

Parameters:

gateway_addr

4 byte array containing the mask to be set with the most significant byte in gateway_addr[0]

void STB_IPSetIPAddress

(

const U8BIT *

ip_addr

)

Sets the IPv4 format IP address of default network connection.

Parameters:

ip_addr

4 byte array containing the IP address to be set with the most significant byte in ip_addr[0]

void STB_IPSetSubnetMask

(

const U8BIT *

subnet_mask

)

Sets the IPv4 format subnet mask of default network connection.

Parameters:

subnet_mask

4 byte array containing the mask to be set with the most significant byte in subnet_mask[0]