bootlib.html

Vxworks API操作系统和驱动程序设计API。压缩的HTML文件

</blockquote><h1>bootParamsShow(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>bootParamsShow(&nbsp;)</strong> - display boot line parameters</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void bootParamsShow
    (
    char * paramString        /* boot parameter string */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine displays the boot parameters in the specified boot string
one parameter per line.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./bootLib.html#top">bootLib</a></b>

<hr>
<a name="bootParamsPrompt"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>bootParamsPrompt(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>bootParamsPrompt(&nbsp;)</strong> - prompt for boot line parameters</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void bootParamsPrompt
    (
    char * string             /* default boot line */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine displays the current value of each boot parameter and prompts
the user for a new value.  Typing a RETURN leaves the parameter unchanged.
Typing a period (.) clears the parameter.
<p>
The parameter <i>string</i> holds the initial values.  The new boot line is
copied over <i>string</i>.  If there are no initial values, <i>string</i> is
empty on entry.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./bootLib.html#top">bootLib</a></b>

<hr>
<a name="bootLeaseExtract"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>bootLeaseExtract(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>bootLeaseExtract(&nbsp;)</strong> - extract the lease information from an Internet address</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>int bootLeaseExtract
    (
    char *   string,          /* string containing addr field */
    u_long * pLeaseLen,       /* pointer to storage for lease duration */
    u_long * pLeaseStart      /* pointer to storage for lease origin */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine extracts the optional lease duration and lease origin fields 
from an Internet address field for use with DHCP.  The lease duration can be 
specified by appending a colon and the lease duration to the netmask field.
For example, the "inet on ethernet" field of the boot parameters could be 
specified as:
<pre>    inet on ethernet: 90.1.0.1:ffff0000:1000
</pre>

If no netmask is specified, the contents of the field could be:
<pre>    inet on ethernet: 90.1.0.1::ffffffff
</pre>

In the first case, the lease duration for the address is 1000 seconds. The 
second case indicates an infinite lease, and does not specify a netmask for
the address. At the beginning of the boot process, the value of the lease
duration field is used to specify the requested lease duration. If the field 
not included, the value of <b>DHCP_DEFAULT_LEASE</b> is used
instead.
<p>
The lease origin is specified with the same format as the lease duration,
but is added during the boot process. The presence of the lease origin
field distinguishes addresses assigned by a DHCP server from addresses
entered manually. Addresses assigned by a DHCP server may be replaced
if the bootstrap loader uses DHCP to obtain configuration parameters.
The value of the lease origin field at the beginning of the boot process
is ignored.
<p>
This routine extracts the optional lease duration by replacing the preceding 
colon in the specified string with an EOS and then scanning the remainder as 
a number.  The lease duration and lease origin values are returned via
the <i>pLeaseLen</i> and <i>pLeaseStart</i> pointers, if those parameters are not NULL.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<p>
&nbsp;&nbsp;2&nbsp;if&nbsp;both&nbsp;lease&nbsp;values&nbsp;are&nbsp;specified&nbsp;correctly&nbsp;in&nbsp;<i>string</i>,&nbsp;or&nbsp;<br>
&nbsp;-2&nbsp;if&nbsp;one&nbsp;of&nbsp;the&nbsp;two&nbsp;values&nbsp;is&nbsp;specified&nbsp;incorrectly.
If only the lease duration is found, it returns:<br>
&nbsp;&nbsp;1&nbsp;if&nbsp;the&nbsp;lease&nbsp;duration&nbsp;in&nbsp;<i>string</i>&nbsp;is&nbsp;specified&nbsp;correctly,<br>
&nbsp;&nbsp;0&nbsp;if&nbsp;the&nbsp;lease&nbsp;duration&nbsp;is&nbsp;not&nbsp;specified&nbsp;in&nbsp;<i>string</i>,&nbsp;or<br>
&nbsp;-1&nbsp;if&nbsp;an&nbsp;invalid&nbsp;lease&nbsp;duration&nbsp;is&nbsp;specified&nbsp;in&nbsp;<i>string</i>.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./bootLib.html#top">bootLib</a></b>

<hr>
<a name="bootNetmaskExtract"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>bootNetmaskExtract(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>bootNetmaskExtract(&nbsp;)</strong> - extract the net mask field from an Internet address</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS bootNetmaskExtract
    (
    char * string,            /* string containing addr field */
    int *  pNetmask           /* pointer where to return net mask */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine extracts the optional subnet mask field from an Internet address
field.  Subnet masks can be specified for an Internet interface by appending
to the Internet address a colon and the net mask in hexadecimal.  
For example, the "inet on ethernet" field of the boot parameters could 
be specified as:
<pre>    inet on ethernet: 90.1.0.1:ffff0000
</pre>
In this case, the network portion of the address (normally just 90)
is extended by the subnet mask (to 90.1).  This routine extracts the
optional trailing subnet mask by replacing the colon in the specified
string with an EOS and then scanning the remainder as a hex number.
This number, the net mask, is returned via the <i>pNetmask</i> pointer.
<p>
This routine also handles an empty netmask field used as a placeholder
for the lease duration field (see <b><a href="./bootLib.html#bootLeaseExtract">bootLeaseExtract</a>(&nbsp;)</b> ). In that case,
the colon separator is replaced with an EOS and the value of netmask is
set to 0. 
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<p>
&nbsp;&nbsp;1&nbsp;if&nbsp;the&nbsp;subnet&nbsp;mask&nbsp;in&nbsp;<i>string</i>&nbsp;is&nbsp;specified&nbsp;correctly,<br>
&nbsp;&nbsp;0&nbsp;if&nbsp;the&nbsp;subnet&nbsp;mask&nbsp;in&nbsp;<i>string</i>&nbsp;is&nbsp;not&nbsp;specified,&nbsp;or<br>
&nbsp;-1&nbsp;if&nbsp;an&nbsp;invalid&nbsp;subnet&nbsp;mask&nbsp;is&nbsp;specified&nbsp;in&nbsp;<i>string</i>.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./bootLib.html#top">bootLib</a></b>

<hr>
<a name="bootBpAnchorExtract"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>bootBpAnchorExtract(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>bootBpAnchorExtract(&nbsp;)</strong> - extract a backplane address from a device field</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS bootBpAnchorExtract
    (
    char * string,            /* string containing adrs field */
    char * *pAnchorAdrs       /* pointer where to return anchor address */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine extracts the optional backplane anchor address field from a
boot device field.  The anchor can be specified for the backplane
driver by appending to the device name (i.e., "bp") an equal sign (=) and the
address in hexadecimal.  For example, the "boot device" field of the boot
parameters could be specified as:
<pre>    boot device: bp=800000
</pre>
In this case, the backplane anchor address would be at address 0x800000,
instead of the default specified in <b>config.h</b>.
<p>
This routine picks off the optional trailing anchor address by replacing
the equal sign (=) in the specified string with an EOS and then scanning the
remainder as a hex number.
This number, the anchor address, is returned via the <i>pAnchorAdrs</i> pointer.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<p>
&nbsp;&nbsp;1&nbsp;if&nbsp;the&nbsp;anchor&nbsp;address&nbsp;in&nbsp;<i>string</i>&nbsp;is&nbsp;specified&nbsp;correctly,<br>
&nbsp;&nbsp;0&nbsp;if&nbsp;the&nbsp;anchor&nbsp;address&nbsp;in&nbsp;<i>string</i>&nbsp;is&nbsp;not&nbsp;specified,&nbsp;or<br>
&nbsp;-1&nbsp;if&nbsp;an&nbsp;invalid&nbsp;anchor&nbsp;address&nbsp;is&nbsp;specified&nbsp;in&nbsp;<i>string</i>.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./bootLib.html#top">bootLib</a></b>

</body>
</html>