cbiolib.html

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

If the <b>CBIO_DEV_ID</b> passed to this routine is not a valid CBIO handle,
ERROR will be returned with errno set to <b>S_cbioLib_INVALID_CBIO_DEV_ID</b>
This routine is not protected by a semaphore.
<p>
This routine will check down to the driver layer to see if any lower
layer has its ready changed bit set to TRUE.  If so, this routine returns
TRUE.  If no lower layer has its ready changed bit set to TRUE, this layer
returns FALSE.
<p>
RETURNS  TRUE if device ready status has changed, else FALSE if 
the ready status has not changed, else ERROR if the <b>CBIO_DEV_ID</b> is invalid.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./cbioLib.html#top">cbioLib</a></b>

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

</blockquote><h1>cbioRdyChgdSet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>cbioRdyChgdSet(&nbsp;)</strong> - force a change in ready status of CBIO device</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS cbioRdyChgdSet
    (
    CBIO_DEV_ID dev,          /* CBIO handle */
    BOOL        status        /* TRUE/FALSE */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
Pass TRUE in status to force READY status change.
<p>
If the <b>CBIO_DEV_ID</b> passed to this routine is not a valid CBIO handle,
ERROR will be returned with errno set to <b>S_cbioLib_INVALID_CBIO_DEV_ID</b>
If status is not passed as TRUE or FALSE, ERROR is returned.
This routine is not protected by a semaphore.
<p>
This routine sets readyChanged bit of passed <b>CBIO_DEV</b>.
<p>
RETURNS  OK or ERROR if the device is invalid or status is not TRUE or FALSE.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./cbioLib.html#top">cbioLib</a></b>

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

</blockquote><h1>cbioLock(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>cbioLock(&nbsp;)</strong> - obtain CBIO device semaphore.</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS cbioLock
    (
    CBIO_DEV_ID dev,          /* CBIO handle */
    int         timeout       /* timeout in ticks */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
If the <b>CBIO_DEV_ID</b> passed to this routine is not a valid CBIO handle,
ERROR will be returned with errno set to <b>S_cbioLib_INVALID_CBIO_DEV_ID</b>
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK or ERROR if the CBIO handle is invalid or semTake fails.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./cbioLib.html#top">cbioLib</a></b>

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

</blockquote><h1>cbioUnlock(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>cbioUnlock(&nbsp;)</strong> - release CBIO device semaphore.</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS cbioUnlock
    (
    CBIO_DEV_ID dev           /* CBIO handle */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
If the <b>CBIO_DEV_ID</b> passed to this routine is not a valid CBIO handle,
ERROR will be returned with errno set to <b>S_cbioLib_INVALID_CBIO_DEV_ID</b>
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK or ERROR if the CBIO handle is invalid or the semGive fails.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./cbioLib.html#top">cbioLib</a></b>

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

</blockquote><h1>cbioParamsGet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>cbioParamsGet(&nbsp;)</strong> - fill in <b>CBIO_PARAMS</b> structure with CBIO device parameters</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS cbioParamsGet
    (
    CBIO_DEV_ID   dev,        /* CBIO handle */
    CBIO_PARAMS * pCbioParams /* pointer to CBIO_PARAMS */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
If the <b>CBIO_DEV_ID</b> passed to this routine is not a valid CBIO handle,
ERROR will be returned with errno set to <b>S_cbioLib_INVALID_CBIO_DEV_ID</b>
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK or ERROR if the CBIO handle is invalid.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./cbioLib.html#top">cbioLib</a></b>

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

</blockquote><h1>cbioShow(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>cbioShow(&nbsp;)</strong> - print information about a CBIO device</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS cbioShow
    (
    CBIO_DEV_ID dev           /* CBIO handle */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This function will display on standard output all information which
is generic for all CBIO devices.
See the CBIO modules particular device show routines for displaying
implementation-specific information.
<p>
It takes two arguments:
<p>
A <b>CBIO_DEV_ID</b> which is the CBIO handle to display or NULL for 
the most recent device.
<p>
RETURNS OK or ERROR if no valid <b>CBIO_DEV</b> is found.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./cbioLib.html#top">cbioLib</a></b>, <b><a href="./dcacheCbio.html#dcacheShow">dcacheShow</a>(&nbsp;)</b>, <b>dpartShow(&nbsp;)</b>

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

</blockquote><h1>cbioDevVerify(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>cbioDevVerify(&nbsp;)</strong> - verify <b>CBIO_DEV_ID</b> </p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS cbioDevVerify
    (
    CBIO_DEV_ID device        /* CBIO_DEV_ID to be verified */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
The purpose of this function is to determine if the device complies with the 
CBIO interface.  It can be used to verify a CBIO handle before it is passed 
to <b><a href="./dosFsLib.html#top">dosFsLib</a></b>, <b><a href="./rawFsLib.html#top">rawFsLib</a></b>, <b><a href="./usrFdiskPartLib.html#top">usrFdiskPartLib</a></b>, or other CBIO modules which expect a 
valid CBIO interface.  
<p>
The device handle provided to this function, <i>device</i> is verified to be a 
CBIO device.  If <i>device</i> is not a CBIO device ERROR is returned with errno 
set to <b>S_cbioLib_INVALID_CBIO_DEV_ID</b>
<p>
The dcacheCbio and dpartCbio CBIO modules (and <b><a href="./dosFsLib.html#top">dosFsLib</a></b>) use this function 
internally, and therefore this function need not be otherwise invoked when 
using compliant CBIO modules.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK or ERROR if not a CBIO device, if passed a NULL address, or 
if the check could cause an unaligned access. 
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./cbioLib.html#top">cbioLib</a></b>, <b><a href="./dosFsLib.html#top">dosFsLib</a></b>, <b><a href="./dcacheCbio.html#top">dcacheCbio</a></b>, <b><a href="./dpartCbio.html#top">dpartCbio</a></b>

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

</blockquote><h1>cbioWrapBlkDev(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>cbioWrapBlkDev(&nbsp;)</strong> - create CBIO wrapper atop a <b>BLK_DEV</b> device</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>CBIO_DEV_ID cbioWrapBlkDev
    (
    BLK_DEV * pDevice         /* BLK_DEV * device pointer */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
The purpose of this function is to make a blkIo (<b>BLK_DEV</b>) device comply 
with the CBIO interface via a wrapper.  
<p>
The device handle provided to this function, <i>device</i> is verified to 
be a blkIo device.  A lean CBIO to <b>BLK_DEV</b> wrapper is then created for 
a valid blkIo device.  The returned <b>CBIO_DEV_ID</b> device handle may be 
used with <b><a href="./dosFsLib.html#dosFsDevCreate">dosFsDevCreate</a>(&nbsp;)</b>, <b><a href="./dcacheCbio.html#dcacheDevCreate">dcacheDevCreate</a>(&nbsp;)</b>, and any other routine 
expecting a valid <b>CBIO_DEV_ID</b> handle.
<p>
To verify a blkIo pointer we see that all mandatory functions
are not NULL.
<p>
Note that if a valid <b>CBIO_DEV_ID</b> is passed to this function, it will 
simply be returned without modification.
<p>
The <b><a href="./dosFsLib.html#top">dosFsLib</a></b>, dcacheCbio, and dpartCbio CBIO modules use this function 
internally, and therefore this function need not be otherwise invoked 
when using those CBIO modules.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
a CBIO device pointer, or NULL if not a blkIo device
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./cbioLib.html#top">cbioLib</a></b>, <b><a href="./dosFsLib.html#top">dosFsLib</a></b>, <b><a href="./dcacheCbio.html#top">dcacheCbio</a></b>, <b><a href="./dpartCbio.html#top">dpartCbio</a></b>

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

</blockquote><h1>cbioDevCreate(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>cbioDevCreate(&nbsp;)</strong> - Initialize a CBIO device (Generic)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>CBIO_DEV_ID cbioDevCreate
    (
    caddr_t ramAddr,          /* where it is in memory (0 = KHEAP_ALLOC) */
    size_t  ramSize           /* pool size */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine will create an empty <b>CBIO_DEV</b> structure and
return a handle to that structure (<b>CBIO_DEV_ID</b>).   
<p>
This routine is intended to be used by CBIO modules only.
See <b>cbioLibP.h</b>
<p>
RETURNS <b>CBIO_DEV_ID</b> or NULL if ERROR.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./cbioLib.html#top">cbioLib</a></b>

</body>
</html>