From: sleybo Date: Sun, 12 Nov 2006 14:47:47 +0000 (+0000) Subject: [DOCS] update docs X-Git-Url: https://openfabrics.org/gitweb/?a=commitdiff_plain;h=f6f63528e2557907c992c21e0b2fa9d5dc355fbc;p=~shefty%2Frdma-win.git [DOCS] update docs git-svn-id: svn://openib.tc.cornell.edu/gen1@541 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86 --- diff --git a/trunk/docs/complib/cl_async_proc_h.html b/trunk/docs/complib/cl_async_proc_h.html index 244bcf0d..316d7ce8 100644 --- a/trunk/docs/complib/cl_async_proc_h.html +++ b/trunk/docs/complib/cl_async_proc_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_async_proc_h.html +./inc_docs/complib/cl_async_proc_h.html -Generated from ./inc/complib/cl_async_proc.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_async_proc.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

[Modules] Component Library/Asynchronous Processor

-

[top][index]

+

[top][parent][index]

NAME

       Asynchronous Processor
 
@@ -23,24 +23,24 @@ Component Library/Asynchronous Processor The threads in the asynchronous processor wait for callbacks to be queued. - The asynchronous processor functions operate on a cl_async_proc_t structure + The asynchronous processor functions operate on a cl_async_proc_t structure which should be treated as opaque and manipulated only through the provided functions.

SEE ALSO

       Structures:
-               cl_async_proc_t, cl_async_proc_item_t
+               cl_async_proc_t, cl_async_proc_item_t
 
        Initialization:
-               cl_async_proc_construct, cl_async_proc_init, cl_async_proc_destroy
+               cl_async_proc_construct, cl_async_proc_init, cl_async_proc_destroy
 
        Manipulation:
-               cl_async_proc_queue
+               cl_async_proc_queue
 

-

[Functions] +

[Functions] Component Library: Asynchronous Processor/cl_async_proc_construct

[top][index]

@@ -54,7 +54,7 @@ Component Library: Asynchronous Processor/cl_async_proc_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_async_proc_construct(
-        IN      cl_async_proc_t* const  p_async_proc );
+        IN      cl_async_proc_t* const  p_async_proc );
 

PARAMETERS

       p_async_proc
@@ -64,19 +64,19 @@ Component Library: Asynchronous Processor/cl_async_proc_construct
 
       This function does not return a value.
 

NOTES

-
       Allows calling cl_async_proc_destroy without first calling
-       cl_async_proc_init.
+
       Allows calling cl_async_proc_destroy without first calling
+       cl_async_proc_init.
 
        Calling cl_async_proc_construct is a prerequisite to calling any other
-       thread pool function except cl_async_proc_init.
+       thread pool function except cl_async_proc_init.
 

SEE ALSO

-
       Asynchronous Processor, cl_async_proc_init, cl_async_proc_destroy
+
       Asynchronous Processor, cl_async_proc_init, cl_async_proc_destroy
 

-

[Functions] +

[Functions] Component Library: Asynchronous Processor/cl_async_proc_destroy

[top][index]

@@ -90,7 +90,7 @@ Component Library: Asynchronous Processor/cl_async_proc_destroy

SYNOPSIS

CL_EXPORT void CL_API
 cl_async_proc_destroy(
-        IN      cl_async_proc_t* const  p_async_proc );
+        IN      cl_async_proc_t* const  p_async_proc );
 

PARAMETERS

       p_async_proc
@@ -106,15 +106,15 @@ Component Library: Asynchronous Processor/cl_async_proc_destroy
        entering a wait state is valid from the calling thread context.
 
        This function should only be called after a call to
-       cl_async_proc_construct or cl_async_proc_init.
+       cl_async_proc_construct or cl_async_proc_init.
 

SEE ALSO

-
       Asynchronous Processor, cl_async_proc_construct, cl_async_proc_init
+
       Asynchronous Processor, cl_async_proc_construct, cl_async_proc_init
 

-

[Functions] +

[Functions] Component Library: Asynchronous Processor/cl_async_proc_init

[top][index]

@@ -126,9 +126,9 @@ Component Library: Asynchronous Processor/cl_async_proc_init

for use.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_async_proc_init(
-        IN      cl_async_proc_t* const  p_async_proc,
+        IN      cl_async_proc_t* const  p_async_proc,
         IN      const uint32_t                  thread_count,
         IN      const char* const               name );
 
@@ -158,13 +158,13 @@ Component Library: Asynchronous Processor/cl_async_proc_init threads as there are processors in the system.

SEE ALSO

-
       Asynchronous Processor, cl_async_proc_construct, cl_async_proc_destroy,
-       cl_async_proc_queue
+
       Asynchronous Processor, cl_async_proc_construct, cl_async_proc_destroy,
+       cl_async_proc_queue
 

-

[Structures] +

[Structures] Component Library: Asynchronous Processor/cl_async_proc_item_t

[top][index]

@@ -172,14 +172,14 @@ Component Library: Asynchronous Processor/cl_async_proc_item_t

       cl_async_proc_item_t
 

DESCRIPTION

-
       Asynchronous processor item structure passed to the cl_async_proc_queue
+
       Asynchronous processor item structure passed to the cl_async_proc_queue
        function to queue a callback for execution.
 

SYNOPSIS

typedef struct _cl_async_proc_item
 {
-        cl_pool_item_t                  pool_item;
-        cl_pfn_async_proc_cb_t  pfn_callback;
+        cl_pool_item_t                  pool_item;
+        cl_pfn_async_proc_cb_t  pfn_callback;
 
 } cl_async_proc_item_t;
 
@@ -193,12 +193,12 @@ Component Library: Asynchronous Processor/cl_async_proc_item_t Pointer to a callback function to invoke when the item is dequeued.

SEE ALSO

-
       Asynchronous Processor, cl_async_proc_queue, cl_pfn_async_proc_cb_t
+
       Asynchronous Processor, cl_async_proc_queue, cl_pfn_async_proc_cb_t
 

-

[Functions] +

[Functions] Component Library: Asynchronous Processor/cl_async_proc_queue

[top][index]

@@ -212,8 +212,8 @@ Component Library: Asynchronous Processor/cl_async_proc_queue

SYNOPSIS

CL_EXPORT void CL_API
 cl_async_proc_queue(
-        IN      cl_async_proc_t* const          p_async_proc,
-        IN      cl_async_proc_item_t* const     p_item );
+        IN      cl_async_proc_t* const          p_async_proc,
+        IN      cl_async_proc_item_t* const     p_item );
 

PARAMETERS

       p_async_proc
@@ -227,12 +227,12 @@ Component Library: Asynchronous Processor/cl_async_proc_queue
        This function does not return a value.
 

SEE ALSO

-
       Asynchronous Processor, cl_async_proc_init, cl_pfn_async_proc_cb_t
+
       Asynchronous Processor, cl_async_proc_init, cl_pfn_async_proc_cb_t
 

-

[Structures] +

[Structures] Component Library: Asynchronous Processor/cl_async_proc_t

[top][index]

@@ -248,8 +248,8 @@ Component Library: Asynchronous Processor/cl_async_proc_t

SYNOPSIS

typedef struct _cl_async_proc
 {
-        cl_thread_pool_t        thread_pool;
-        cl_qlist_t                      item_queue;
+        cl_thread_pool_t        thread_pool;
+        cl_qlist_t                      item_queue;
         cl_spinlock_t           lock;
         cl_state_t                      state;
 
@@ -275,7 +275,7 @@ Component Library: Asynchronous Processor/cl_async_proc_t
 
 
-

[Definitions] +

[Definitions] Component Library: Asynchronous Processor/cl_pfn_async_proc_cb_t

[top][index]

@@ -293,16 +293,16 @@ Component Library: Asynchronous Processor/cl_pfn_async_proc_cb_t

PARAMETERS

       p_item
-               Pointer to the cl_async_proc_item_t structure that was queued in
-               a call to cl_async_proc_queue.
+               Pointer to the cl_async_proc_item_t structure that was queued in
+               a call to cl_async_proc_queue.
 

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_async_proc_queue
+       function provided by users as a parameter to the cl_async_proc_queue
        function.
 

SEE ALSO

-
       Asynchronous Processor, cl_async_proc_item_t
+
       Asynchronous Processor, cl_async_proc_item_t
 
diff --git a/trunk/docs/complib/cl_atomic_h.html b/trunk/docs/complib/cl_atomic_h.html index cedd0831..1e92689d 100644 --- a/trunk/docs/complib/cl_atomic_h.html +++ b/trunk/docs/complib/cl_atomic_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_atomic_h.html +./inc_docs/complib/cl_atomic_h.html -Generated from ./inc/complib/cl_atomic.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_atomic.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

[Modules] Component Library/Atomic Operations

-

[top][index]

+

[top][parent][index]

NAME

       Atomic Operations
 
@@ -25,7 +25,7 @@ Component Library/Atomic Operations

-

[Functions] +

[Functions] Component Library: Atomic Operations/cl_atomic_add

[top][index]

@@ -60,13 +60,13 @@ Component Library: Atomic Operations/cl_atomic_add

synchronization mechanisms in multi-threaded environments.

SEE ALSO

-
       Atomic Operations, cl_atomic_inc, cl_atomic_dec, cl_atomic_sub,
-       cl_atomic_xchg, cl_atomic_comp_xchg
+
       Atomic Operations, cl_atomic_inc, cl_atomic_dec, cl_atomic_sub,
+       cl_atomic_xchg, cl_atomic_comp_xchg
 

-

[Functions] +

[Functions] Component Library: Atomic Operations/cl_atomic_comp_xchg

[top][index]

@@ -108,13 +108,13 @@ Component Library: Atomic Operations/cl_atomic_comp_xchg

synchronization mechanisms in multi-threaded environments.

SEE ALSO

-
       Atomic Operations, cl_atomic_inc, cl_atomic_dec, cl_atomic_add,
-       cl_atomic_sub, cl_atomic_xchg
+
       Atomic Operations, cl_atomic_inc, cl_atomic_dec, cl_atomic_add,
+       cl_atomic_sub, cl_atomic_xchg
 

-

[Functions] +

[Functions] Component Library: Atomic Operations/cl_atomic_dec

[top][index]

@@ -145,13 +145,13 @@ Component Library: Atomic Operations/cl_atomic_dec

synchronization mechanisms in multi-threaded environments.

SEE ALSO

-
       Atomic Operations, cl_atomic_inc, cl_atomic_add, cl_atomic_sub,
-       cl_atomic_xchg, cl_atomic_comp_xchg
+
       Atomic Operations, cl_atomic_inc, cl_atomic_add, cl_atomic_sub,
+       cl_atomic_xchg, cl_atomic_comp_xchg
 

-

[Functions] +

[Functions] Component Library: Atomic Operations/cl_atomic_inc

[top][index]

@@ -182,13 +182,13 @@ Component Library: Atomic Operations/cl_atomic_inc

synchronization mechanisms in multi-threaded environments.

SEE ALSO

-
       Atomic Operations, cl_atomic_dec, cl_atomic_add, cl_atomic_sub,
-       cl_atomic_xchg, cl_atomic_comp_xchg
+
       Atomic Operations, cl_atomic_dec, cl_atomic_add, cl_atomic_sub,
+       cl_atomic_xchg, cl_atomic_comp_xchg
 

-

[Functions] +

[Functions] Component Library: Atomic Operations/cl_atomic_sub

[top][index]

@@ -223,13 +223,13 @@ Component Library: Atomic Operations/cl_atomic_sub

synchronization mechanisms in multi-threaded environments.

SEE ALSO

-
       Atomic Operations, cl_atomic_inc, cl_atomic_dec, cl_atomic_add,
-       cl_atomic_xchg, cl_atomic_comp_xchg
+
       Atomic Operations, cl_atomic_inc, cl_atomic_dec, cl_atomic_add,
+       cl_atomic_xchg, cl_atomic_comp_xchg
 

-

[Functions] +

[Functions] Component Library: Atomic Operations/cl_atomic_xchg

[top][index]

@@ -264,8 +264,8 @@ Component Library: Atomic Operations/cl_atomic_xchg

synchronization mechanisms in multi-threaded environments.

SEE ALSO

-
       Atomic Operations, cl_atomic_inc, cl_atomic_dec, cl_atomic_add,
-       cl_atomic_sub, cl_atomic_comp_xchg
+
       Atomic Operations, cl_atomic_inc, cl_atomic_dec, cl_atomic_add,
+       cl_atomic_sub, cl_atomic_comp_xchg
 
diff --git a/trunk/docs/complib/cl_byteswap_h.html b/trunk/docs/complib/cl_byteswap_h.html index cc72311c..04f4e22e 100644 --- a/trunk/docs/complib/cl_byteswap_h.html +++ b/trunk/docs/complib/cl_byteswap_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_byteswap_h.html +./inc_docs/complib/cl_byteswap_h.html -Generated from ./inc/complib/cl_byteswap.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_byteswap.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

[Modules] Component Library/Byte Swapping

-

[top][index]

+

[top][parent][index]

NAME

       Byte Swapping
 
@@ -28,16 +28,16 @@ Component Library/Byte Swapping

SEE ALSO

       Functions:
-               cl_ntoh16, cl_hton16, cl_ntoh32, cl_hton32, cl_ntoh64, cl_hton64,
-               cl_ntoh
+               cl_ntoh16, cl_hton16, cl_ntoh32, cl_hton32, cl_ntoh64, cl_hton64,
+               cl_ntoh
 
        Macros:
-               CL_NTOH16, CL_HTON16, CL_NTOH32, CL_HTON32, CL_NTOH64, CL_HTON64
+               CL_NTOH16, CL_HTON16, CL_NTOH32, CL_HTON32, CL_NTOH64, CL_HTON64
 

-

[Definitions] +

[Definitions] Component Library: Byte Swapping/CL_HTON16

[top][index]

@@ -48,7 +48,7 @@ Component Library: Byte Swapping/CL_HTON16

       The CL_HTON16 macro converts a 16-bit value from host byte order to
        network byte order.  The CL_HTON16 macro will cause constant values to be
        swapped by the pre-processor.  For variables, CL_HTON16 is less efficient
-       than the cl_hton16 function.
+       than the cl_hton16 function.
 

SYNOPSIS

*       CL_HTON16( val );
@@ -61,16 +61,16 @@ Component Library: Byte Swapping/CL_HTON16
 
       Value of val converted to network byte order.
 

NOTES

-
       This macro is analogous to CL_NTOH16.
+
       This macro is analogous to CL_NTOH16.
 

SEE ALSO

-
       Byte Swapping, CL_NTOH16, CL_HTON32, CL_HTON64,
-       cl_hton16, cl_hton32, cl_hton64, cl_ntoh
+
       Byte Swapping, CL_NTOH16, CL_HTON32, CL_HTON64,
+       cl_hton16, cl_hton32, cl_hton64, cl_ntoh
 

-

[Functions] +

[Functions] Component Library: Byte Swapping/cl_hton16

[top][index]

@@ -94,15 +94,15 @@ Component Library: Byte Swapping/cl_hton16

       Value of val converted to network byte order.
 

NOTES

-
       This function is analogous to cl_ntoh16.
+
       This function is analogous to cl_ntoh16.
 

SEE ALSO

-
       Byte Swapping, cl_ntoh16, cl_hton32, cl_hton64, cl_ntoh
+
       Byte Swapping, cl_ntoh16, cl_hton32, cl_hton64, cl_ntoh
 

-

[Definitions] +

[Definitions] Component Library: Byte Swapping/CL_HTON32

[top][index]

@@ -113,7 +113,7 @@ Component Library: Byte Swapping/CL_HTON32

       The CL_HTON32 macro converts a 32-bit value from host byte order to
        network byte order.  The CL_HTON32 macro will cause constant values to be
        swapped by the pre-processor.  For variables, CL_HTON32 is less efficient
-       than the cl_hton32 function.
+       than the cl_hton32 function.
 

SYNOPSIS

*       CL_HTON32( val );
@@ -126,16 +126,16 @@ Component Library: Byte Swapping/CL_HTON32
 
       Value of val converted to network byte order.
 

NOTES

-
       This macro is analogous to CL_NTOH32.
+
       This macro is analogous to CL_NTOH32.
 

SEE ALSO

-
       Byte Swapping, CL_NTOH32, CL_HTON16, CL_HTON64,
-       cl_hton16, cl_hton32, cl_hton64, cl_ntoh
+
       Byte Swapping, CL_NTOH32, CL_HTON16, CL_HTON64,
+       cl_hton16, cl_hton32, cl_hton64, cl_ntoh
 

-

[Functions] +

[Functions] Component Library: Byte Swapping/cl_hton32

[top][index]

@@ -159,15 +159,15 @@ Component Library: Byte Swapping/cl_hton32

       Value of val converted to network byte order.
 

NOTES

-
       This function is analogous to cl_ntoh32.
+
       This function is analogous to cl_ntoh32.
 

SEE ALSO

-
       Byte Swapping, cl_ntoh32, cl_hton16, cl_hton64, cl_ntoh
+
       Byte Swapping, cl_ntoh32, cl_hton16, cl_hton64, cl_ntoh
 

-

[Definitions] +

[Definitions] Component Library: Byte Swapping/CL_HTON64

[top][index]

@@ -178,7 +178,7 @@ Component Library: Byte Swapping/CL_HTON64

       The CL_HTON64 macro converts a 64-bit value from host byte order to
        network byte order.  The CL_HTON64 macro will cause constant values to be
        swapped by the pre-processor.  For variables, CL_HTON64 is less efficient
-       than the cl_hton64 function.
+       than the cl_hton64 function.
 

SYNOPSIS

*       CL_HTON64( val );
@@ -191,16 +191,16 @@ Component Library: Byte Swapping/CL_HTON64
 
       Value of val converted to network byte order.
 

NOTES

-
       This macro is analogous to CL_NTOH64.
+
       This macro is analogous to CL_NTOH64.
 

SEE ALSO

-
       Byte Swapping, CL_NTOH64, CL_HTON16, CL_HTON32,
-       cl_hton16, cl_hton32, cl_hton64, cl_ntoh
+
       Byte Swapping, CL_NTOH64, CL_HTON16, CL_HTON32,
+       cl_hton16, cl_hton32, cl_hton64, cl_ntoh
 

-

[Functions] +

[Functions] Component Library: Byte Swapping/cl_hton64

[top][index]

@@ -224,15 +224,15 @@ Component Library: Byte Swapping/cl_hton64

       Value of val converted to network byte order.
 

NOTES

-
       This function is analogous to cl_ntoh64.
+
       This function is analogous to cl_ntoh64.
 

SEE ALSO

-
       Byte Swapping, cl_ntoh64, cl_hton16, cl_hton32, cl_ntoh
+
       Byte Swapping, cl_ntoh64, cl_hton16, cl_hton32, cl_ntoh
 

-

[Functions] +

[Functions] Component Library: Byte Swapping/cl_ntoh

[top][index]

@@ -275,7 +275,7 @@ Component Library: Byte Swapping/cl_ntoh

* the destination. */ if( p_src != p_dest ) - cl_memcpy( p_dest, p_src, size ); + cl_memcpy( p_dest, p_src, size ); #endif }
@@ -298,12 +298,12 @@ Component Library: Byte Swapping/cl_ntoh the same buffer.

SEE ALSO

-
       Byte Swapping, cl_ntoh16, cl_ntoh32, cl_ntoh64
+
       Byte Swapping, cl_ntoh16, cl_ntoh32, cl_ntoh64
 

-

[Definitions] +

[Definitions] Component Library: Byte Swapping/CL_NTOH16

[top][index]

@@ -314,7 +314,7 @@ Component Library: Byte Swapping/CL_NTOH16

       The CL_NTOH16 macro converts a 16-bit value from network byte order to
        host byte order.  The CL_NTOH16 macro will cause constant values to be
        swapped by the pre-processor.  For variables, CL_NTOH16 is less efficient
-       than the cl_ntoh16 function.
+       than the cl_ntoh16 function.
 

SYNOPSIS

*       CL_NTOH16( val );
@@ -327,16 +327,16 @@ Component Library: Byte Swapping/CL_NTOH16
 
       Value of val converted to host byte order.
 

NOTES

-
       This macro is analogous to CL_HTON16.
+
       This macro is analogous to CL_HTON16.
 

SEE ALSO

-
       Byte Swapping, CL_HTON16, CL_NTOH32, CL_NTOH64,
-       cl_ntoh16, cl_ntoh32, cl_ntoh64, cl_ntoh
+
       Byte Swapping, CL_HTON16, CL_NTOH32, CL_NTOH64,
+       cl_ntoh16, cl_ntoh32, cl_ntoh64, cl_ntoh
 

-

[Functions] +

[Functions] Component Library: Byte Swapping/cl_ntoh16

[top][index]

@@ -360,15 +360,15 @@ Component Library: Byte Swapping/cl_ntoh16

       Value of val converted to host byte order.
 

NOTES

-
       This function is analogous to cl_hton16.
+
       This function is analogous to cl_hton16.
 

SEE ALSO

-
       Byte Swapping, cl_hton16, cl_ntoh32, cl_ntoh64, cl_ntoh
+
       Byte Swapping, cl_hton16, cl_ntoh32, cl_ntoh64, cl_ntoh
 

-

[Functions] +

[Functions] Component Library: Byte Swapping/cl_ntoh32

[top][index]

@@ -392,15 +392,15 @@ Component Library: Byte Swapping/cl_ntoh32

       Value of val converted in host byte order.
 

NOTES

-
       This function is analogous to cl_hton32.
+
       This function is analogous to cl_hton32.
 

SEE ALSO

-
       Byte Swapping, cl_hton32, cl_ntoh16, cl_ntoh64, cl_ntoh
+
       Byte Swapping, cl_hton32, cl_ntoh16, cl_ntoh64, cl_ntoh
 

-

[Definitions] +

[Definitions] Component Library: Byte Swapping/CL_NTOH32

[top][index]

@@ -411,7 +411,7 @@ Component Library: Byte Swapping/CL_NTOH32

       The CL_NTOH32 macro converts a 32-bit value from network byte order to
        host byte order.  The CL_NTOH32 macro will cause constant values to be
        swapped by the pre-processor.  For variables, CL_NTOH32 is less efficient
-       than the cl_ntoh32 function.
+       than the cl_ntoh32 function.
 

SYNOPSIS

*       CL_NTOH32( val );
@@ -424,16 +424,16 @@ Component Library: Byte Swapping/CL_NTOH32
 
       Value of val converted to host byte order.
 

NOTES

-
       This macro is analogous to CL_HTON32.
+
       This macro is analogous to CL_HTON32.
 

SEE ALSO

-
       Byte Swapping, CL_HTON32, CL_NTOH16, CL_NTOH64,
-       cl_ntoh16, cl_ntoh32, cl_ntoh64, cl_ntoh
+
       Byte Swapping, CL_HTON32, CL_NTOH16, CL_NTOH64,
+       cl_ntoh16, cl_ntoh32, cl_ntoh64, cl_ntoh
 

-

[Definitions] +

[Definitions] Component Library: Byte Swapping/CL_NTOH64

[top][index]

@@ -444,7 +444,7 @@ Component Library: Byte Swapping/CL_NTOH64

       The CL_NTOH64 macro converts a 64-bit value from network byte order to
        host byte order.  The CL_NTOH64 macro will cause constant values to be
        swapped by the pre-processor.  For variables, CL_NTOH64 is less efficient
-       than the cl_ntoh64 function.
+       than the cl_ntoh64 function.
 

SYNOPSIS

*       CL_NTOH64( val );
@@ -457,16 +457,16 @@ Component Library: Byte Swapping/CL_NTOH64
 
       Value of val converted to host byte order.
 

NOTES

-
       This macro is analogous to CL_HTON64.
+
       This macro is analogous to CL_HTON64.
 

SEE ALSO

-
       Byte Swapping, CL_HTON64, CL_NTOH16, CL_NTOH32,
-       cl_ntoh16, cl_ntoh32, cl_ntoh64, cl_ntoh
+
       Byte Swapping, CL_HTON64, CL_NTOH16, CL_NTOH32,
+       cl_ntoh16, cl_ntoh32, cl_ntoh64, cl_ntoh
 

-

[Functions] +

[Functions] Component Library: Byte Swapping/cl_ntoh64

[top][index]

@@ -490,10 +490,10 @@ Component Library: Byte Swapping/cl_ntoh64

       Value of val converted in host byte order.
 

NOTES

-
       This function is analogous to cl_hton64.
+
       This function is analogous to cl_hton64.
 

SEE ALSO

-
       Byte Swapping, cl_hton64, cl_ntoh16, cl_ntoh32, cl_ntoh
+
       Byte Swapping, cl_hton64, cl_ntoh16, cl_ntoh32, cl_ntoh
 
diff --git a/trunk/docs/complib/cl_comppool_h.html b/trunk/docs/complib/cl_comppool_h.html index f1b063fb..b3f91a41 100644 --- a/trunk/docs/complib/cl_comppool_h.html +++ b/trunk/docs/complib/cl_comppool_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_comppool_h.html +./inc_docs/complib/cl_comppool_h.html -Generated from ./inc/complib/cl_comppool.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_comppool.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

-

[Modules] +

[Modules] Component Library/Composite Pool

-

[top][index]

+

[top][parent][index]

NAME

       Composite Pool
 
@@ -36,30 +36,30 @@ Component Library/Composite Pool

objects to the pool. The only method of returning memory to the system is to destroy the pool. - The composite pool functions operates on a cl_cpool_t structure which + The composite pool functions operates on a cl_cpool_t structure which should be treated as opaque and should be manipulated only through the provided functions.

SEE ALSO

       Structures:
-               cl_cpool_t
+               cl_cpool_t
 
        Callbacks:
-               cl_pfn_cpool_init_t, cl_pfn_cpool_dtor_t
+               cl_pfn_cpool_init_t, cl_pfn_cpool_dtor_t
 
        Initialization/Destruction:
-               cl_cpool_construct, cl_cpool_init, cl_cpool_destroy
+               cl_cpool_construct, cl_cpool_init, cl_cpool_destroy
 
        Manipulation:
-               cl_cpool_get, cl_cpool_put, cl_cpool_grow
+               cl_cpool_get, cl_cpool_put, cl_cpool_grow
 
        Attributes:
-               cl_is_cpool_inited, cl_cpool_count
+               cl_is_cpool_inited, cl_cpool_count
 

-

[Functions] +

[Functions] Component Library: Composite Pool/cl_cpool_construct

[top][index]

@@ -72,28 +72,28 @@ Component Library: Composite Pool/cl_cpool_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_cpool_construct(
-        IN      cl_cpool_t* const       p_pool );
+        IN      cl_cpool_t* const       p_pool );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_cpool_t structure whose state to initialize.
+               [in] Pointer to a cl_cpool_t structure whose state to initialize.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       Allows calling cl_pool_init, cl_cpool_destroy, cl_is_cpool_inited.
+
       Allows calling cl_pool_init, cl_cpool_destroy, cl_is_cpool_inited.
 
        Calling cl_cpool_construct is a prerequisite to calling any other
-       composite pool function except cl_cpool_init.
+       composite pool function except cl_cpool_init.
 

SEE ALSO

-
       Composite Pool, cl_cpool_init, cl_cpool_destroy, cl_is_cpool_inited
+
       Composite Pool, cl_cpool_init, cl_cpool_destroy, cl_is_cpool_inited
 

-

[Functions] +

[Functions] Component Library: Composite Pool/cl_cpool_count

[top][index]

@@ -107,15 +107,15 @@ Component Library: Composite Pool/cl_cpool_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_cpool_count(
-        IN      cl_cpool_t* const       p_pool )
+        IN      cl_cpool_t* const       p_pool )
 {
         CL_ASSERT( p_pool );
-        return( cl_qcpool_count( &p_pool->qcpool ) );
+        return( cl_qcpool_count( &p_pool->qcpool ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_cpool_t structure for which the number of
+               [in] Pointer to a cl_cpool_t structure for which the number of
                available objects is requested.
 

RETURN VALUE

@@ -128,7 +128,7 @@ Component Library: Composite Pool/cl_cpool_count
-

[Functions] +

[Functions] Component Library: Composite Pool/cl_cpool_destroy

[top][index]

@@ -141,16 +141,16 @@ Component Library: Composite Pool/cl_cpool_destroy

SYNOPSIS

CL_INLINE void CL_API
 cl_cpool_destroy(
-        IN      cl_cpool_t* const       p_pool )
+        IN      cl_cpool_t* const       p_pool )
 {
         CL_ASSERT( p_pool );
 
-        cl_qcpool_destroy( &p_pool->qcpool );
+        cl_qcpool_destroy( &p_pool->qcpool );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_cpool_t structure to destroy.
+               [in] Pointer to a cl_cpool_t structure to destroy.
 

RETURN VALUE

       This function does not return a value.
@@ -161,18 +161,18 @@ Component Library: Composite Pool/cl_cpool_destroy
        operations on the composite pool should not be attempted after
        cl_cpool_destroy is invoked.
 
-       This function should only be called after a call to cl_cpool_construct.
+       This function should only be called after a call to cl_cpool_construct.
 
        In a debug build, cl_cpool_destroy asserts that all objects are in
        the pool.
 

SEE ALSO

-
       Composite Pool, cl_cpool_construct, cl_cpool_init
+
       Composite Pool, cl_cpool_construct, cl_cpool_init
 

-

[Functions] +

[Functions] Component Library: Composite Pool/cl_cpool_get

[top][index]

@@ -186,13 +186,13 @@ Component Library: Composite Pool/cl_cpool_get

SYNOPSIS

CL_INLINE void* CL_API
 cl_cpool_get(
-        IN      cl_cpool_t* const       p_pool )
+        IN      cl_cpool_t* const       p_pool )
 {
         cl_pool_obj_t   *p_pool_obj;
 
         CL_ASSERT( p_pool );
 
-        p_pool_obj = (cl_pool_obj_t*)cl_qcpool_get( &p_pool->qcpool );
+        p_pool_obj = (cl_pool_obj_t*)cl_qcpool_get( &p_pool->qcpool );
         if( !p_pool_obj )
                 return( NULL );
 
@@ -202,7 +202,7 @@ Component Library: Composite Pool/cl_cpool_get
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_cpool_t structure from which to retrieve
+               [in] Pointer to a cl_cpool_t structure from which to retrieve
                an object.
 
  RETURN VALUES
@@ -213,16 +213,16 @@ Component Library: Composite Pool/cl_cpool_get
 

NOTES

       cl_cpool_get returns the object at the head of the pool. If the pool is
        empty, it is automatically grown to accommodate this request unless the
-       grow_size parameter passed to the cl_cpool_init function was zero.
+       grow_size parameter passed to the cl_cpool_init function was zero.
 

SEE ALSO

-
       Composite Pool, cl_cpool_get_tail, cl_cpool_put, cl_cpool_grow,
-       cl_cpool_count
+
       Composite Pool, cl_cpool_get_tail, cl_cpool_put, cl_cpool_grow,
+       cl_cpool_count
 

-

[Functions] +

[Functions] Component Library: Composite Pool/cl_cpool_grow

[top][index]

@@ -234,18 +234,18 @@ Component Library: Composite Pool/cl_cpool_grow

the specified number of objects.

SYNOPSIS

-
CL_INLINE cl_status_t CL_API
+
CL_INLINE cl_status_t CL_API
 cl_cpool_grow(
-        IN      cl_cpool_t* const       p_pool,
+        IN      cl_cpool_t* const       p_pool,
         IN      const size_t            obj_count )
 {
         CL_ASSERT( p_pool );
-        return( cl_qcpool_grow( &p_pool->qcpool, obj_count ) );
+        return( cl_qcpool_grow( &p_pool->qcpool, obj_count ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_cpool_t structure whose capacity to grow.
+               [in] Pointer to a cl_cpool_t structure whose capacity to grow.
 
        obj_count
                [in] Number of objects by which to grow the pool.
@@ -256,9 +256,9 @@ Component Library: Composite Pool/cl_cpool_grow
        CL_INSUFFICIENT_MEMORY if there was not enough memory to grow the
        composite pool.
 
-       cl_status_t value returned by optional initialization callback function
+       cl_status_t value returned by optional initialization callback function
        specified by the pfn_initializer parameter passed to the
-       cl_cpool_init function.
+       cl_cpool_init function.
 

NOTES

       It is not necessary to call cl_cpool_grow if the pool is
@@ -270,7 +270,7 @@ Component Library: Composite Pool/cl_cpool_grow
 
 
-

[Functions] +

[Functions] Component Library: Composite Pool/cl_cpool_init

[top][index]

@@ -281,21 +281,21 @@ Component Library: Composite Pool/cl_cpool_init

       The cl_cpool_init function initializes a composite pool for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_cpool_init(
-        IN      cl_cpool_t* const               p_pool,
+        IN      cl_cpool_t* const               p_pool,
         IN      const size_t                    min_size,
         IN      const size_t                    max_size,
         IN      const size_t                    grow_size,
         IN      size_t* const                   component_sizes,
         IN      const uint32_t                  num_components,
-        IN      cl_pfn_cpool_init_t             pfn_initializer OPTIONAL,
-        IN      cl_pfn_cpool_dtor_t             pfn_destructor OPTIONAL,
+        IN      cl_pfn_cpool_init_t             pfn_initializer OPTIONAL,
+        IN      cl_pfn_cpool_dtor_t             pfn_destructor OPTIONAL,
         IN      const void* const               context );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_cpool_t structure to initialize.
+               [in] Pointer to a cl_cpool_t structure to initialize.
 
        min_size
                [in] Minimum number of objects that the pool should support. All
@@ -344,7 +344,7 @@ Component Library: Composite Pool/cl_cpool_init
        consisting of more than one component.  Also returns CL_INVALID_SETTING if
        the maximum size is non-zero and less than the minimum size.
 
-       Other cl_status_t value returned by optional initialization callback function
+       Other cl_status_t value returned by optional initialization callback function
        specified by the pfn_initializer parameter.
 

NOTES

@@ -352,15 +352,15 @@ Component Library: Composite Pool/cl_cpool_init the capacity desired.

SEE ALSO

-
       Composite Pool, cl_cpool_construct, cl_cpool_destroy,
-       cl_cpool_get, cl_cpool_put, cl_cpool_grow,
-       cl_cpool_count, cl_pfn_cpool_ctor_t, cl_pfn_cpool_init_t,
-       cl_pfn_cpool_dtor_t
+
       Composite Pool, cl_cpool_construct, cl_cpool_destroy,
+       cl_cpool_get, cl_cpool_put, cl_cpool_grow,
+       cl_cpool_count, cl_pfn_cpool_ctor_t, cl_pfn_cpool_init_t,
+       cl_pfn_cpool_dtor_t
 

-

[Functions] +

[Functions] Component Library: Composite Pool/cl_cpool_put

[top][index]

@@ -373,7 +373,7 @@ Component Library: Composite Pool/cl_cpool_put

SYNOPSIS

CL_INLINE void CL_API
 cl_cpool_put(
-        IN      cl_cpool_t* const       p_pool,
+        IN      cl_cpool_t* const       p_pool,
         IN      void* const                     p_object )
 {
         cl_pool_obj_t   *p_pool_obj;
@@ -388,12 +388,12 @@ Component Library: Composite Pool/cl_cpool_put
         /* good sanity check */
         CL_ASSERT( p_pool_obj->list_obj.p_object == p_object );
 
-        cl_qcpool_put( &p_pool->qcpool, (cl_pool_item_t*)p_pool_obj );
+        cl_qcpool_put( &p_pool->qcpool, (cl_pool_item_t*)p_pool_obj );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_cpool_t structure to which to return
+               [in] Pointer to a cl_cpool_t structure to which to return
                an object.
 
        p_object
@@ -406,15 +406,15 @@ Component Library: Composite Pool/cl_cpool_put
 
       cl_cpool_put places the returned object at the head of the pool.
 
        The object specified by the p_object parameter must have been
-       retrieved from the pool by a previous call to cl_cpool_get.
+       retrieved from the pool by a previous call to cl_cpool_get.
 

SEE ALSO

-
       Composite Pool, cl_cpool_put_tail, cl_cpool_get
+
       Composite Pool, cl_cpool_put_tail, cl_cpool_get
 

-

[Structures] +

[Structures] Component Library: Composite Pool/cl_cpool_t

[top][index]

@@ -430,9 +430,9 @@ Component Library: Composite Pool/cl_cpool_t

SYNOPSIS

typedef struct _cl_cpool
 {
-        cl_qcpool_t                             qcpool;
-        cl_pfn_cpool_init_t             pfn_init;
-        cl_pfn_cpool_dtor_t             pfn_dtor;
+        cl_qcpool_t                             qcpool;
+        cl_pfn_cpool_init_t             pfn_init;
+        cl_pfn_cpool_dtor_t             pfn_dtor;
         const void                              *context;
 
 } cl_cpool_t;
@@ -461,7 +461,7 @@ Component Library: Composite Pool/cl_cpool_t
 
 
-

[Functions] +

[Functions] Component Library: Composite Pool/cl_is_cpool_inited

[top][index]

@@ -475,16 +475,16 @@ Component Library: Composite Pool/cl_is_cpool_inited

SYNOPSIS

CL_INLINE boolean_t CL_API
 cl_is_cpool_inited(
-        IN      const cl_cpool_t* const p_pool )
+        IN      const cl_cpool_t* const p_pool )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_pool );
-        return( cl_is_qcpool_inited( &p_pool->qcpool ) );
+        return( cl_is_qcpool_inited( &p_pool->qcpool ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_cpool_t structure whose initialization state
+               [in] Pointer to a cl_cpool_t structure whose initialization state
                to check.
 
  RETURN VALUES
@@ -502,7 +502,7 @@ Component Library: Composite Pool/cl_is_cpool_inited
 
 
-

[Definitions] +

[Definitions] Component Library: Composite Pool/cl_pfn_cpool_dtor_t

[top][index]

@@ -525,7 +525,7 @@ Component Library: Composite Pool/cl_pfn_cpool_dtor_t

[in] Pointer to an object to destruct. context - [in] Context provided in the call to cl_cpool_init. + [in] Context provided in the call to cl_cpool_init.

RETURN VALUE

       This function does not return a value.
@@ -533,7 +533,7 @@ Component Library: Composite Pool/cl_pfn_cpool_dtor_t
 

NOTES

       This function type is provided as function prototype reference for
        the function provided by the user as an optional parameter to the
-       cl_cpool_init function.
+       cl_cpool_init function.
 
        The destructor is invoked once per allocated object, allowing the user
        to perform any necessary cleanup. Users should not attempt to deallocate
@@ -541,12 +541,12 @@ Component Library: Composite Pool/cl_pfn_cpool_dtor_t
        object allocation and deallocation.
 

SEE ALSO

-
       Composite Pool, cl_cpool_init
+
       Composite Pool, cl_cpool_init
 

-

[Definitions] +

[Definitions] Component Library: Composite Pool/cl_pfn_cpool_init_t

[top][index]

@@ -559,7 +559,7 @@ Component Library: Composite Pool/cl_pfn_cpool_init_t

composite pool.

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_cpool_init_t)(
         IN      void** const            p_comp_array,
         IN      const uint32_t          num_components,
@@ -570,34 +570,34 @@ Component Library: Composite Pool/cl_pfn_cpool_init_t
                [in] Pointer to an object to initialize.
 
        context
-               [in] Context provided in a call to cl_cpool_init.
+               [in] Context provided in a call to cl_cpool_init.
 
  RETURN VALUES
        Return CL_SUCCESS to indicates that initialization of the object
        was successful and that initialization of further objects may continue.
 
-       Other cl_status_t values will be returned by cl_cpool_init
-       and cl_cpool_grow.
+       Other cl_status_t values will be returned by cl_cpool_init
+       and cl_cpool_grow.
 

NOTES

       This function type is provided as function prototype reference for
        the function provided by the user as an optional parameter to the
-       cl_cpool_init function.
+       cl_cpool_init function.
 
        The initializer is invoked once per allocated object, allowing the user
        to chain components to form a composite object and perform any necessary
        initialization.  Returning a status other than CL_SUCCESS aborts a grow
-       operation, initiated either through cl_cpool_init or cl_cpool_grow, and
+       operation, initiated either through cl_cpool_init or cl_cpool_grow, and
        causes the initiating function to fail.  Any non-CL_SUCCESS status will
        be returned by the function that initiated the grow operation.
 
        All memory for the requested number of components is pre-allocated.
 
-       When later performing a cl_cpool_get call, the return value is a pointer
+       When later performing a cl_cpool_get call, the return value is a pointer
        to the first component.
 

SEE ALSO

-
       Composite Pool, cl_cpool_init, cl_cpool_grow
+
       Composite Pool, cl_cpool_init, cl_cpool_grow
 
diff --git a/trunk/docs/complib/cl_debug_h.html b/trunk/docs/complib/cl_debug_h.html index e4268b7c..41897f37 100644 --- a/trunk/docs/complib/cl_debug_h.html +++ b/trunk/docs/complib/cl_debug_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_debug_h.html +./inc_docs/complib/cl_debug_h.html -Generated from ./inc/complib/cl_debug.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_debug.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

-

[Modules] +

[Modules] Component Library/Debug Output

-

[top][index]

+

[top][parent][index]

NAME

       Debug Output
 
@@ -25,7 +25,7 @@ Component Library/Debug Output


-

[Definitions] +

[Definitions] Component Library: Debug Output/64-bit Print Format

[top][index]

@@ -53,7 +53,7 @@ Component Library: Debug Output/64-bit Print Format

EXAMPLE

       uint64 MyVal = 2;
        // Print a 64-bit integer in hexadecimal format.
-       cl_dbg_out( "MyVal: 0x%" PRIx64 "\n", MyVal );
+       cl_dbg_out( "MyVal: 0x%" PRIx64 "\n", MyVal );
 

NOTES

       Standard print flags to specify padding and precision can still be used
@@ -65,7 +65,7 @@ Component Library: Debug Output/64-bit Print Format
 
 
-

[Functions] +

[Functions] Component Library: Debug Output/cl_break

[top][index]

@@ -88,7 +88,7 @@ Component Library: Debug Output/cl_break


-

[Functions] +

[Functions] Component Library: Debug Output/cl_dbg_out

[top][index]

@@ -125,12 +125,12 @@ Component Library: Debug Output/cl_dbg_out

cl_dbg_out sends the debug message to the current debug target.

SEE ALSO

-
       Debug Output, cl_msg_out
+
       Debug Output, cl_msg_out
 

-

[Definitions] +

[Definitions] Component Library: Debug Output/CL_ENTER

[top][index]

@@ -165,7 +165,7 @@ Component Library: Debug Output/CL_ENTER

my_func() { CL_ENTER( MY_FUNC_DBG_LVL, my_dbg_lvl ); - CL_EXIT( MY_FUNC_DBG_LVL, my_dbg_lvl ); + CL_EXIT( MY_FUNC_DBG_LVL, my_dbg_lvl ); }

RESULT

@@ -184,12 +184,12 @@ Component Library: Debug Output/CL_ENTER is generated is prepended to the output.

SEE ALSO

-
       Debug Output, Debug Levels, CL_PRINT, CL_EXIT, CL_TRACE, CL_TRACE_EXIT
+
       Debug Output, Debug Levels, CL_PRINT, CL_EXIT, CL_TRACE, CL_TRACE_EXIT
 

-

[Definitions] +

[Definitions] Component Library: Debug Output/CL_EXIT

[top][index]

@@ -223,7 +223,7 @@ Component Library: Debug Output/CL_EXIT

void my_func() { - CL_ENTER( MY_FUNC_DBG_LVL, my_dbg_lvl ); + CL_ENTER( MY_FUNC_DBG_LVL, my_dbg_lvl ); CL_EXIT( MY_FUNC_DBG_LVL, my_dbg_lvl ); }
@@ -246,12 +246,12 @@ Component Library: Debug Output/CL_EXIT is generated is prepended to the output.

SEE ALSO

-
       Debug Output, Debug Levels, CL_PRINT, CL_ENTER, CL_TRACE, CL_TRACE_EXIT
+
       Debug Output, Debug Levels, CL_PRINT, CL_ENTER, CL_TRACE, CL_TRACE_EXIT
 

-

[Functions] +

[Functions] Component Library: Debug Output/cl_msg_out

[top][index]

@@ -287,12 +287,12 @@ Component Library: Debug Output/cl_msg_out

cl_msg_out sends the message to the current message logging target.

SEE ALSO

-
       Debug Output, cl_dbg_out
+
       Debug Output, cl_dbg_out
 

-

[Definitions] +

[Definitions] Component Library: Debug Output/CL_PRINT

[top][index]

@@ -345,12 +345,12 @@ Component Library: Debug Output/CL_PRINT

is generated is prepended to the output.

SEE ALSO

-
       Debug Output, Debug Levels, CL_ENTER, CL_EXIT, CL_TRACE, CL_TRACE_EXIT
+
       Debug Output, Debug Levels, CL_ENTER, CL_EXIT, CL_TRACE, CL_TRACE_EXIT
 

-

[Definitions] +

[Definitions] Component Library: Debug Output/CL_TRACE

[top][index]

@@ -389,9 +389,9 @@ Component Library: Debug Output/CL_TRACE

void my_func() { - CL_ENTER( MY_FUNC_DBG_LVL, my_dbg_lvl ); + CL_ENTER( MY_FUNC_DBG_LVL, my_dbg_lvl ); CL_TRACE( MY_FUNC_DBG_LVL, my_dbg_lvl, ("Hello %s!\n", "world") ); - CL_EXIT( MY_FUNC_DBG_LVL, my_dbg_lvl ); + CL_EXIT( MY_FUNC_DBG_LVL, my_dbg_lvl ); }

RESULT

@@ -417,12 +417,12 @@ Component Library: Debug Output/CL_TRACE is generated is prepended to the output.

SEE ALSO

-
       Debug Output, Debug Levels, CL_PRINT, CL_ENTER, CL_EXIT, CL_TRACE_EXIT
+
       Debug Output, Debug Levels, CL_PRINT, CL_ENTER, CL_EXIT, CL_TRACE_EXIT
 

-

[Definitions] +

[Definitions] Component Library: Debug Output/CL_TRACE_EXIT

[top][index]

@@ -430,8 +430,8 @@ Component Library: Debug Output/CL_TRACE_EXIT

       CL_TRACE_EXIT
 

DESCRIPTION

-
       The CL_TRACE_EXIT macro combines the functionality of the CL_TRACE and
-       CL_EXIT macros, in that order.
+
       The CL_TRACE_EXIT macro combines the functionality of the CL_TRACE and
+       CL_EXIT macros, in that order.
 

SYNOPSIS

*       CL_TRACE_EXIT(  DBG_LVL, CHK_LVL, STRING );
@@ -459,7 +459,7 @@ Component Library: Debug Output/CL_TRACE_EXIT
        void
        my_func()
        {
-               CL_ENTER( MY_FUNC_DBG_LVL, my_dbg_lvl );
+               CL_ENTER( MY_FUNC_DBG_LVL, my_dbg_lvl );
                CL_TRACE_EXIT( MY_FUNC_DBG_LVL, my_dbg_lvl, ("Hello %s!\n", "world") );
        }
 
@@ -486,12 +486,12 @@ Component Library: Debug Output/CL_TRACE_EXIT is generated is prepended to the output.

SEE ALSO

-
       Debug Output, Debug Levels, CL_PRINT, CL_ENTER, CL_EXIT, CL_TRACE
+
       Debug Output, Debug Levels, CL_PRINT, CL_ENTER, CL_EXIT, CL_TRACE
 

-

[Definitions] +

[Definitions] Component Library: Debug Output/Debug Levels

[top][index]

@@ -527,7 +527,7 @@ Component Library: Debug Output/Debug Levels

all bits whose output they are interested in.

SEE ALSO

-
       Debug Output, CL_PRINT, CL_ENTER, CL_EXIT, CL_TRACE, CL_TRACE_EXIT
+
       Debug Output, CL_PRINT, CL_ENTER, CL_EXIT, CL_TRACE, CL_TRACE_EXIT
 
diff --git a/trunk/docs/complib/cl_event_h.html b/trunk/docs/complib/cl_event_h.html index 6d7714b5..f16cc666 100644 --- a/trunk/docs/complib/cl_event_h.html +++ b/trunk/docs/complib/cl_event_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_event_h.html +./inc_docs/complib/cl_event_h.html -Generated from ./inc/complib/cl_event.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_event.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

-

[Modules] +

[Modules] Component Library/Event

-

[top][index]

+

[top][parent][index]

NAME

       Event
 
@@ -30,15 +30,15 @@ Component Library/Event

cl_event_t Initialization/Destruction: - cl_event_construct, cl_event_init, cl_event_destroy + cl_event_construct, cl_event_init, cl_event_destroy Manipulation: - cl_event_signal, cl_event_reset, cl_event_wait_on + cl_event_signal, cl_event_reset, cl_event_wait_on

-

[Functions] +

[Functions] Component Library: Event/cl_event_construct

[top][index]

@@ -61,18 +61,18 @@ Component Library: Event/cl_event_construct

       This function does not return a value.
 

NOTES

-
       Allows calling cl_event_destroy without first calling cl_event_init.
+
       Allows calling cl_event_destroy without first calling cl_event_init.
 
        Calling cl_event_construct is a prerequisite to calling any other event
-       function except cl_event_init.
+       function except cl_event_init.
 

SEE ALSO

-
       Event, cl_event_init, cl_event_destroy
+
       Event, cl_event_init, cl_event_destroy
 

-

[Functions] +

[Functions] Component Library: Event/cl_event_destroy

[top][index]

@@ -95,16 +95,16 @@ Component Library: Event/cl_event_destroy

       This function does not return a value.
 

NOTES

-
       This function should only be called after a call to cl_event_construct
-       or cl_event_init.
+
       This function should only be called after a call to cl_event_construct
+       or cl_event_init.
 

SEE ALSO

-
       Event, cl_event_construct, cl_event_init
+
       Event, cl_event_construct, cl_event_init
 

-

[Functions] +

[Functions] Component Library: Event/cl_event_init

[top][index]

@@ -115,7 +115,7 @@ Component Library: Event/cl_event_init

       The cl_event_init function initializes an event for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_event_init(
         IN      cl_event_t* const       p_event,
         IN      const boolean_t         manual_reset );
@@ -127,7 +127,7 @@ Component Library: Event/cl_event_init
        manual_reset
                [in] If FALSE, indicates that the event resets itself after releasing
                a single waiter.  If TRUE, the event remains in the signalled state
-               until explicitly reset by a call to cl_event_reset.
+               until explicitly reset by a call to cl_event_reset.
 
  RETURN VALUES
        CL_SUCCESS if event initialization succeeded.
@@ -135,19 +135,19 @@ Component Library: Event/cl_event_init
        CL_ERROR otherwise.
 

NOTES

-
       Allows calling event manipulation functions, such as cl_event_signal,
-       cl_event_reset, and cl_event_wait_on.
+
       Allows calling event manipulation functions, such as cl_event_signal,
+       cl_event_reset, and cl_event_wait_on.
 
        The event is initially in a reset state.
 

SEE ALSO

-
       Event, cl_event_construct, cl_event_destroy, cl_event_signal,
-       cl_event_reset, cl_event_wait_on
+
       Event, cl_event_construct, cl_event_destroy, cl_event_signal,
+       cl_event_reset, cl_event_wait_on
 

-

[Functions] +

[Functions] Component Library: Event/cl_event_reset

[top][index]

@@ -158,7 +158,7 @@ Component Library: Event/cl_event_reset

       The cl_event_reset function sets an event to the non-signalled state.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_event_reset(
         IN      cl_event_t* const       p_event );
 
@@ -172,12 +172,12 @@ Component Library: Event/cl_event_reset CL_ERROR otherwise.

SEE ALSO

-
       Event, cl_event_signal, cl_event_wait_on
+
       Event, cl_event_signal, cl_event_wait_on
 

-

[Functions] +

[Functions] Component Library: Event/cl_event_signal

[top][index]

@@ -189,7 +189,7 @@ Component Library: Event/cl_event_signal

releases one or more waiting threads.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_event_signal(
         IN      cl_event_t* const       p_event );
 
@@ -212,12 +212,12 @@ Component Library: Event/cl_event_signal that is already in the signalled state has no effect.

SEE ALSO

-
       Event, cl_event_reset, cl_event_wait_on
+
       Event, cl_event_reset, cl_event_wait_on
 

-

[Functions] +

[Functions] Component Library: Event/cl_event_wait_on

[top][index]

@@ -229,7 +229,7 @@ Component Library: Event/cl_event_wait_on

triggered for a minimum amount of time.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_event_wait_on(
         IN      cl_event_t* const       p_event,
         IN      const uint32_t          wait_us,
@@ -267,7 +267,7 @@ Component Library: Event/cl_event_wait_on
        to cl_event_wait_on, the call completes immediately with CL_SUCCESS.
 

SEE ALSO

-
       Event, cl_event_signal, cl_event_reset
+
       Event, cl_event_signal, cl_event_reset
 
diff --git a/trunk/docs/complib/cl_fleximap_h.html b/trunk/docs/complib/cl_fleximap_h.html index 4d594e1a..17f20351 100644 --- a/trunk/docs/complib/cl_fleximap_h.html +++ b/trunk/docs/complib/cl_fleximap_h.html @@ -2,24 +2,24 @@ -./inc_doc/complib/cl_fleximap_h.html +./inc_docs/complib/cl_fleximap_h.html -Generated from ./inc/complib/cl_fleximap.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_fleximap.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

-

[Modules] +

[Modules] Component Library/Flexi Map

-

[top][index]

+

[top][parent][index]

NAME

-
       Flexi Map
+
       Flexi Map
 

DESCRIPTION

-
       Flexi map implements a binary tree that stores user provided cl_fmap_item_t
+
       Flexi map implements a binary tree that stores user provided cl_fmap_item_t
        structures.  Each item stored in a flexi map has a unique user defined key
        (duplicates are not allowed).  Flexi map provides the ability to
        efficiently search for an item given a key.  Flexi map allows user defined
@@ -33,40 +33,40 @@ Component Library/Flexi Map

Flexi map is not thread safe, and users must provide serialization when adding and removing items from the map. - The flexi map functions operate on a cl_fmap_t structure which should + The flexi map functions operate on a cl_fmap_t structure which should be treated as opaque and should be manipulated only through the provided functions.

SEE ALSO

       Structures:
-               cl_fmap_t, cl_fmap_item_t
+               cl_fmap_t, cl_fmap_item_t
 
        Callbacks:
-               cl_pfn_fmap_apply_t
+               cl_pfn_fmap_apply_t
 
        Item Manipulation:
-               cl_fmap_key
+               cl_fmap_key
 
        Initialization:
-               cl_fmap_init
+               cl_fmap_init
 
        Iteration:
-               cl_fmap_end, cl_fmap_head, cl_fmap_tail, cl_fmap_next, cl_fmap_prev
+               cl_fmap_end, cl_fmap_head, cl_fmap_tail, cl_fmap_next, cl_fmap_prev
 
        Manipulation:
-               cl_fmap_insert, cl_fmap_get, cl_fmap_remove_item, cl_fmap_remove,
-               cl_fmap_remove_all, cl_fmap_merge, cl_fmap_delta
+               cl_fmap_insert, cl_fmap_get, cl_fmap_remove_item, cl_fmap_remove,
+               cl_fmap_remove_all, cl_fmap_merge, cl_fmap_delta
 
        Search:
-               cl_fmap_apply_func
+               cl_fmap_apply_func
 
        Attributes:
-               cl_fmap_count, cl_is_fmap_empty,
+               cl_fmap_count, cl_is_fmap_empty,
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_apply_func

[top][index]

@@ -80,17 +80,17 @@ Component Library: Flexi Map/cl_fmap_apply_func

SYNOPSIS

CL_EXPORT void CL_API
 cl_fmap_apply_func(
-        IN      const cl_fmap_t* const  p_map,
-        IN      cl_pfn_fmap_apply_t             pfn_func,
+        IN      const cl_fmap_t* const  p_map,
+        IN      cl_pfn_fmap_apply_t             pfn_func,
         IN      const void* const               context );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure.
+               [in] Pointer to a cl_fmap_t structure.
 
        pfn_func
                [in] Function invoked for every item in the flexi map.
-               See the cl_pfn_fmap_apply_t function type declaration for details
+               See the cl_pfn_fmap_apply_t function type declaration for details
                about the callback function.
 
        context
@@ -104,12 +104,12 @@ Component Library: Flexi Map/cl_fmap_apply_func
        would corrupt the flexi map.
 

SEE ALSO

-
       Flexi Map, cl_pfn_fmap_apply_t
+
       Flexi Map, cl_pfn_fmap_apply_t
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_count

[top][index]

@@ -123,7 +123,7 @@ Component Library: Flexi Map/cl_fmap_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_fmap_count(
-        IN      const cl_fmap_t* const  p_map )
+        IN      const cl_fmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -132,18 +132,18 @@ Component Library: Flexi Map/cl_fmap_count
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure whose item count to return.
+               [in] Pointer to a cl_fmap_t structure whose item count to return.
 

RETURN VALUE

       Returns the number of items stored in the map.
 

SEE ALSO

-
       Flexi Map, cl_is_fmap_empty
+
       Flexi Map, cl_is_fmap_empty
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_delta

[top][index]

@@ -156,26 +156,26 @@ Component Library: Flexi Map/cl_fmap_delta

SYNOPSIS

CL_EXPORT void CL_API
 cl_fmap_delta(
-        IN OUT  cl_fmap_t* const        p_map1,
-        IN OUT  cl_fmap_t* const        p_map2,
-        OUT             cl_fmap_t* const        p_new,
-        OUT             cl_fmap_t* const        p_old );
+        IN OUT  cl_fmap_t* const        p_map1,
+        IN OUT  cl_fmap_t* const        p_map2,
+        OUT             cl_fmap_t* const        p_new,
+        OUT             cl_fmap_t* const        p_old );
 

PARAMETERS

       p_map1
-               [in/out] Pointer to the first of two cl_fmap_t structures whose
+               [in/out] Pointer to the first of two cl_fmap_t structures whose
                differences to compute.
 
        p_map2
-               [in/out] Pointer to the second of two cl_fmap_t structures whose
+               [in/out] Pointer to the second of two cl_fmap_t structures whose
                differences to compute.
 
        p_new
-               [out] Pointer to an empty cl_fmap_t structure that contains the items
+               [out] Pointer to an empty cl_fmap_t structure that contains the items
                unique to p_map2 upon return from the function.
 
        p_old
-               [out] Pointer to an empty cl_fmap_t structure that contains the items
+               [out] Pointer to an empty cl_fmap_t structure that contains the items
                unique to p_map1 upon return from the function.
 
  RETURN VALUES
@@ -192,12 +192,12 @@ Component Library: Flexi Map/cl_fmap_delta
        requirement removes the possibility of failures.
 

SEE ALSO

-
       Flexi Map, cl_fmap_merge
+
       Flexi Map, cl_fmap_merge
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_end

[top][index]

@@ -208,9 +208,9 @@ Component Library: Flexi Map/cl_fmap_end

       The cl_fmap_end function returns the end of a flexi map.
 

SYNOPSIS

-
CL_INLINE const cl_fmap_item_t* const CL_API
+
CL_INLINE const cl_fmap_item_t* const CL_API
 cl_fmap_end(
-        IN      const cl_fmap_t* const  p_map )
+        IN      const cl_fmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -220,26 +220,26 @@ Component Library: Flexi Map/cl_fmap_end
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure whose end to return.
+               [in] Pointer to a cl_fmap_t structure whose end to return.
 

RETURN VALUE

       Pointer to the end of the map.
 

NOTES

       cl_fmap_end is useful for determining the validity of map items returned
-       by cl_fmap_head, cl_fmap_tail, cl_fmap_next, or cl_fmap_prev.  If the map
+       by cl_fmap_head, cl_fmap_tail, cl_fmap_next, or cl_fmap_prev.  If the map
        item pointer returned by any of these functions compares to the end, the
        end of the map was encoutered.
-       When using cl_fmap_head or cl_fmap_tail, this condition indicates that
+       When using cl_fmap_head or cl_fmap_tail, this condition indicates that
        the map is empty.
 

SEE ALSO

-
       Flexi Map, cl_fmap_head, cl_fmap_tail, cl_fmap_next, cl_fmap_prev
+
       Flexi Map, cl_fmap_head, cl_fmap_tail, cl_fmap_next, cl_fmap_prev
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_get

[top][index]

@@ -250,14 +250,14 @@ Component Library: Flexi Map/cl_fmap_get

       The cl_fmap_get function returns the map item associated with a key.
 

SYNOPSIS

-
CL_EXPORT cl_fmap_item_t* CL_API
+
CL_EXPORT cl_fmap_item_t* CL_API
 cl_fmap_get(
-        IN      const cl_fmap_t* const  p_map,
+        IN      const cl_fmap_t* const  p_map,
         IN      const void* const               p_key );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure from which to retrieve the
+               [in] Pointer to a cl_fmap_t structure from which to retrieve the
                item with the specified key.
 
        p_key
@@ -273,12 +273,12 @@ Component Library: Flexi Map/cl_fmap_get
 
       cl_fmap_get does not remove the item from the flexi map.
 

SEE ALSO

-
       Flexi Map, cl_fmap_remove
+
       Flexi Map, cl_fmap_remove
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_head

[top][index]

@@ -290,18 +290,18 @@ Component Library: Flexi Map/cl_fmap_head

value stored in a flexi map.

SYNOPSIS

-
CL_INLINE cl_fmap_item_t* CL_API
+
CL_INLINE cl_fmap_item_t* CL_API
 cl_fmap_head(
-        IN      const cl_fmap_t* const  p_map )
+        IN      const cl_fmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
-        return( (cl_fmap_item_t*)p_map->nil.pool_item.list_item.p_next );
+        return( (cl_fmap_item_t*)p_map->nil.pool_item.list_item.p_next );
 }
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure whose item with the lowest key
+               [in] Pointer to a cl_fmap_t structure whose item with the lowest key
                is returned.
 
  RETURN VALUES
@@ -313,13 +313,13 @@ Component Library: Flexi Map/cl_fmap_head
 
       cl_fmap_head does not remove the item from the map.
 

SEE ALSO

-
       Flexi Map, cl_fmap_tail, cl_fmap_next, cl_fmap_prev, cl_fmap_end,
-       cl_fmap_item_t
+
       Flexi Map, cl_fmap_tail, cl_fmap_next, cl_fmap_prev, cl_fmap_end,
+       cl_fmap_item_t
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_init

[top][index]

@@ -332,16 +332,16 @@ Component Library: Flexi Map/cl_fmap_init

SYNOPSIS

CL_EXPORT void CL_API
 cl_fmap_init(
-        IN      cl_fmap_t* const        p_map,
-        IN      cl_pfn_fmap_cmp_t       pfn_compare );
+        IN      cl_fmap_t* const        p_map,
+        IN      cl_pfn_fmap_cmp_t       pfn_compare );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure to initialize.
+               [in] Pointer to a cl_fmap_t structure to initialize.
 
        pfn_compare
                [in] Pointer to the compare function used to compare keys.
-               See the cl_pfn_fmap_cmp_t function type declaration for details
+               See the cl_pfn_fmap_cmp_t function type declaration for details
                about the callback function.
 
  RETURN VALUES
@@ -351,12 +351,12 @@ Component Library: Flexi Map/cl_fmap_init
 
       Allows calling flexi map manipulation functions.
 

SEE ALSO

-
       Flexi Map, cl_fmap_insert, cl_fmap_remove
+
       Flexi Map, cl_fmap_insert, cl_fmap_remove
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_insert

[top][index]

@@ -367,15 +367,15 @@ Component Library: Flexi Map/cl_fmap_insert

       The cl_fmap_insert function inserts a map item into a flexi map.
 

SYNOPSIS

-
CL_EXPORT cl_fmap_item_t* CL_API
+
CL_EXPORT cl_fmap_item_t* CL_API
 cl_fmap_insert(
-        IN      cl_fmap_t* const                p_map,
+        IN      cl_fmap_t* const                p_map,
         IN      const void* const               p_key,
-        IN      cl_fmap_item_t* const   p_item );
+        IN      cl_fmap_item_t* const   p_item );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure into which to add the item.
+               [in] Pointer to a cl_fmap_t structure into which to add the item.
 
        p_key
                [in] Pointer to the key value to assign to the item.  Storage for
@@ -384,7 +384,7 @@ Component Library: Flexi Map/cl_fmap_insert
                they are in use.
 
        p_item
-               [in] Pointer to a cl_fmap_item_t stucture to insert into the flexi map.
+               [in] Pointer to a cl_fmap_item_t stucture to insert into the flexi map.
 

RETURN VALUE

       Pointer to the item in the map with the specified key.  If insertion
@@ -396,12 +396,12 @@ Component Library: Flexi Map/cl_fmap_insert
 
       Insertion operations may cause the flexi map to rebalance.
 

SEE ALSO

-
       Flexi Map, cl_fmap_remove, cl_fmap_item_t
+
       Flexi Map, cl_fmap_remove, cl_fmap_item_t
 

-

[Structures] +

[Structures] Component Library: Flexi Map/cl_fmap_item_t

[top][index]

@@ -418,7 +418,7 @@ Component Library: Flexi Map/cl_fmap_item_t

typedef struct _cl_fmap_item
 {
         /* Must be first to allow casting. */
-        cl_pool_item_t                  pool_item;
+        cl_pool_item_t                  pool_item;
         struct _cl_fmap_item    *p_left;
         struct _cl_fmap_item    *p_right;
         struct _cl_fmap_item    *p_up;
@@ -446,15 +446,15 @@ Component Library: Flexi Map/cl_fmap_item_t
 
        p_nil
                Pointer to the map's NIL item, used as a terminator for leaves.
-               The NIL sentinel is in the cl_fmap_t structure.
+               The NIL sentinel is in the cl_fmap_t structure.
 
        color
                Indicates whether a node is red or black in the map.
 
        p_key
                Pointer to the value that uniquely represents a node in a map.  This
-               pointer is set by calling cl_fmap_insert and can be retrieved by
-               calling cl_fmap_key.
+               pointer is set by calling cl_fmap_insert and can be retrieved by
+               calling cl_fmap_key.
 

NOTES

       None of the fields of this structure should be manipulated by users, as
@@ -471,12 +471,12 @@ Component Library: Flexi Map/cl_fmap_item_t
        The flexi map item is defined to be identical in layout as a map item.
 

SEE ALSO

-
       Flexi Map, cl_fmap_insert, cl_fmap_key, cl_pool_item_t, cl_list_item_t
+
       Flexi Map, cl_fmap_insert, cl_fmap_key, cl_pool_item_t, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_key

[top][index]

@@ -491,7 +491,7 @@ Component Library: Flexi Map/cl_fmap_key

#pragma warning (disable :4244) CL_INLINE const void* CL_API cl_fmap_key( - IN const cl_fmap_item_t* const p_item ) + IN const cl_fmap_item_t* const p_item ) { CL_ASSERT( p_item ); return( p_item->p_key ); @@ -507,15 +507,15 @@ CL_INLINE const void* CL_API The key value should not be modified to insure proper flexi map operation.

NOTES

-
       The key value is set in a call to cl_fmap_insert.
+
       The key value is set in a call to cl_fmap_insert.
 

SEE ALSO

-
       Flexi Map, cl_fmap_insert
+
       Flexi Map, cl_fmap_insert
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_merge

[top][index]

@@ -529,15 +529,15 @@ Component Library: Flexi Map/cl_fmap_merge

SYNOPSIS

CL_EXPORT void CL_API
 cl_fmap_merge(
-        OUT             cl_fmap_t* const        p_dest_map,
-        IN OUT  cl_fmap_t* const        p_src_map );
+        OUT             cl_fmap_t* const        p_dest_map,
+        IN OUT  cl_fmap_t* const        p_src_map );
 

PARAMETERS

       p_dest_map
-               [out] Pointer to a cl_fmap_t structure to which items should be added.
+               [out] Pointer to a cl_fmap_t structure to which items should be added.
 
        p_src_map
-               [in/out] Pointer to a cl_fmap_t structure whose items to add
+               [in/out] Pointer to a cl_fmap_t structure whose items to add
                to p_dest_map.
 
  RETURN VALUES
@@ -550,12 +550,12 @@ Component Library: Flexi Map/cl_fmap_merge
        contains all duplicate items.
 

SEE ALSO

-
       Flexi Map, cl_fmap_delta
+
       Flexi Map, cl_fmap_delta
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_next

[top][index]

@@ -567,12 +567,12 @@ Component Library: Flexi Map/cl_fmap_next

key value than a specified map item.

SYNOPSIS

-
CL_INLINE cl_fmap_item_t* CL_API
+
CL_INLINE cl_fmap_item_t* CL_API
 cl_fmap_next(
-        IN      const cl_fmap_item_t* const     p_item )
+        IN      const cl_fmap_item_t* const     p_item )
 {
         CL_ASSERT( p_item );
-        return( (cl_fmap_item_t*)p_item->pool_item.list_item.p_next );
+        return( (cl_fmap_item_t*)p_item->pool_item.list_item.p_next );
 }
 

PARAMETERS

@@ -586,13 +586,13 @@ Component Library: Flexi Map/cl_fmap_next the flexi map.

SEE ALSO

-
       Flexi Map, cl_fmap_head, cl_fmap_tail, cl_fmap_prev, cl_fmap_end,
-       cl_fmap_item_t
+
       Flexi Map, cl_fmap_head, cl_fmap_tail, cl_fmap_prev, cl_fmap_end,
+       cl_fmap_item_t
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_prev

[top][index]

@@ -604,12 +604,12 @@ Component Library: Flexi Map/cl_fmap_prev

key value than a precified map item.

SYNOPSIS

-
CL_INLINE cl_fmap_item_t* CL_API
+
CL_INLINE cl_fmap_item_t* CL_API
 cl_fmap_prev(
-        IN      const cl_fmap_item_t* const     p_item )
+        IN      const cl_fmap_item_t* const     p_item )
 {
         CL_ASSERT( p_item );
-        return( (cl_fmap_item_t*)p_item->pool_item.list_item.p_prev );
+        return( (cl_fmap_item_t*)p_item->pool_item.list_item.p_prev );
 }
 

PARAMETERS

@@ -623,13 +623,13 @@ Component Library: Flexi Map/cl_fmap_prev the flexi map.

SEE ALSO

-
       Flexi Map, cl_fmap_head, cl_fmap_tail, cl_fmap_next, cl_fmap_end,
-       cl_fmap_item_t
+
       Flexi Map, cl_fmap_head, cl_fmap_tail, cl_fmap_next, cl_fmap_end,
+       cl_fmap_item_t
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_remove

[top][index]

@@ -641,14 +641,14 @@ Component Library: Flexi Map/cl_fmap_remove

from a flexi map.

SYNOPSIS

-
CL_EXPORT cl_fmap_item_t* CL_API
+
CL_EXPORT cl_fmap_item_t* CL_API
 cl_fmap_remove(
-        IN      cl_fmap_t* const        p_map,
+        IN      cl_fmap_t* const        p_map,
         IN      const void* const       p_key );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure from which to remove the item
+               [in] Pointer to a cl_fmap_t structure from which to remove the item
                with the specified key.
 
        p_key
@@ -662,12 +662,12 @@ Component Library: Flexi Map/cl_fmap_remove
        flexi map.
 

SEE ALSO

-
       Flexi Map, cl_fmap_remove_item, cl_fmap_remove_all, cl_fmap_insert
+
       Flexi Map, cl_fmap_remove_item, cl_fmap_remove_all, cl_fmap_insert
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_remove_all

[top][index]

@@ -681,7 +681,7 @@ Component Library: Flexi Map/cl_fmap_remove_all

SYNOPSIS

CL_INLINE void CL_API
 cl_fmap_remove_all(
-        IN      cl_fmap_t* const        p_map )
+        IN      cl_fmap_t* const        p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -694,18 +694,18 @@ Component Library: Flexi Map/cl_fmap_remove_all
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure to empty.
+               [in] Pointer to a cl_fmap_t structure to empty.
 
  RETURN VALUES
        This function does not return a value.
 

SEE ALSO

-
       Flexi Map, cl_fmap_remove, cl_fmap_remove_item
+
       Flexi Map, cl_fmap_remove, cl_fmap_remove_item
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_remove_item

[top][index]

@@ -719,8 +719,8 @@ Component Library: Flexi Map/cl_fmap_remove_item

SYNOPSIS

CL_EXPORT void CL_API
 cl_fmap_remove_item(
-        IN      cl_fmap_t* const                p_map,
-        IN      cl_fmap_item_t* const   p_item );
+        IN      cl_fmap_t* const                p_map,
+        IN      cl_fmap_item_t* const   p_item );
 

PARAMETERS

       p_item
@@ -736,12 +736,12 @@ Component Library: Flexi Map/cl_fmap_remove_item
 
       Removes the map item pointed to by p_item from its flexi map.
 

SEE ALSO

-
       Flexi Map, cl_fmap_remove, cl_fmap_remove_all, cl_fmap_insert
+
       Flexi Map, cl_fmap_remove, cl_fmap_remove_all, cl_fmap_insert
 

-

[Structures] +

[Structures] Component Library: Flexi Map/cl_fmap_t

[top][index]

@@ -757,22 +757,22 @@ Component Library: Flexi Map/cl_fmap_t

SYNOPSIS

typedef struct _cl_fmap
 {
-        cl_fmap_item_t          root;
-        cl_fmap_item_t          nil;
+        cl_fmap_item_t          root;
+        cl_fmap_item_t          nil;
         cl_state_t                      state;
         size_t                          count;
-        cl_pfn_fmap_cmp_t       pfn_compare;
+        cl_pfn_fmap_cmp_t       pfn_compare;
 
 } cl_fmap_t;
 

PARAMETERS

       root
-               Map item that serves as root of the map.  The root is set up to
+               Map item that serves as root of the map.  The root is set up to
                always have itself as parent.  The left pointer is set to point to
                the item at the root.
 
        nil
-               Map item that serves as terminator for all leaves, as well as providing
+               Map item that serves as terminator for all leaves, as well as providing
                the list item used as quick list for storing map items in a list for
                faster traversal.
 
@@ -787,12 +787,12 @@ Component Library: Flexi Map/cl_fmap_t
                items in the map.
 

SEE ALSO

-
       Flexi Map, cl_pfn_fmap_cmp_t
+
       Flexi Map, cl_pfn_fmap_cmp_t
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_fmap_tail

[top][index]

@@ -804,18 +804,18 @@ Component Library: Flexi Map/cl_fmap_tail

value stored in a flexi map.

SYNOPSIS

-
CL_INLINE cl_fmap_item_t* CL_API
+
CL_INLINE cl_fmap_item_t* CL_API
 cl_fmap_tail(
-        IN      const cl_fmap_t* const  p_map )
+        IN      const cl_fmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
-        return( (cl_fmap_item_t*)p_map->nil.pool_item.list_item.p_prev );
+        return( (cl_fmap_item_t*)p_map->nil.pool_item.list_item.p_prev );
 }
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure whose item with the highest key
+               [in] Pointer to a cl_fmap_t structure whose item with the highest key
                is returned.
 
  RETURN VALUES
@@ -824,16 +824,16 @@ Component Library: Flexi Map/cl_fmap_tail
        Pointer to the map end if the flexi map was empty.
 

NOTES

-
       cl_fmap_end does not remove the item from the map.
+
       cl_fmap_end does not remove the item from the map.
 

SEE ALSO

-
       Flexi Map, cl_fmap_head, cl_fmap_next, cl_fmap_prev, cl_fmap_end,
-       cl_fmap_item_t
+
       Flexi Map, cl_fmap_head, cl_fmap_next, cl_fmap_prev, cl_fmap_end,
+       cl_fmap_item_t
 

-

[Functions] +

[Functions] Component Library: Flexi Map/cl_is_fmap_empty

[top][index]

@@ -846,7 +846,7 @@ Component Library: Flexi Map/cl_is_fmap_empty

SYNOPSIS

CL_INLINE boolean_t CL_API
 cl_is_fmap_empty(
-        IN      const cl_fmap_t* const  p_map )
+        IN      const cl_fmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -856,7 +856,7 @@ Component Library: Flexi Map/cl_is_fmap_empty
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_fmap_t structure to test for emptiness.
+               [in] Pointer to a cl_fmap_t structure to test for emptiness.
 
  RETURN VALUES
        TRUE if the flexi map is empty.
@@ -864,12 +864,12 @@ Component Library: Flexi Map/cl_is_fmap_empty
        FALSE otherwise.
 

SEE ALSO

-
       Flexi Map, cl_fmap_count, cl_fmap_remove_all
+
       Flexi Map, cl_fmap_count, cl_fmap_remove_all
 

-

[Definitions] +

[Definitions] Component Library: Flexi Map/cl_pfn_fmap_apply_t

[top][index]

@@ -883,12 +883,12 @@ Component Library: Flexi Map/cl_pfn_fmap_apply_t

SYNOPSIS

typedef void
 (CL_API *cl_pfn_fmap_apply_t)(
-        IN      cl_fmap_item_t* const   p_map_item,
+        IN      cl_fmap_item_t* const   p_map_item,
         IN      void*                                   context );
 

PARAMETERS

       p_map_item
-               [in] Pointer to a cl_fmap_item_t structure.
+               [in] Pointer to a cl_fmap_item_t structure.
 
        context
                [in] Value passed to the callback function.
@@ -898,16 +898,16 @@ Component Library: Flexi Map/cl_pfn_fmap_apply_t
 

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_fmap_apply_func
+       function provided by users as a parameter to the cl_fmap_apply_func
        function.
 

SEE ALSO

-
       Flexi Map, cl_fmap_apply_func
+
       Flexi Map, cl_fmap_apply_func
 

-

[Definitions] +

[Definitions] Component Library: Flexi Map/cl_pfn_fmap_cmp_t

[top][index]

@@ -938,10 +938,10 @@ Component Library: Flexi Map/cl_pfn_fmap_cmp_t

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_fmap_init function.
+       function provided by users as a parameter to the cl_fmap_init function.
 

SEE ALSO

-
       Flexi Map, cl_fmap_init
+
       Flexi Map, cl_fmap_init
 
diff --git a/trunk/docs/complib/cl_ioctl_h.html b/trunk/docs/complib/cl_ioctl_h.html index a93c3eec..fd38ac0a 100644 --- a/trunk/docs/complib/cl_ioctl_h.html +++ b/trunk/docs/complib/cl_ioctl_h.html @@ -2,28 +2,28 @@ -./inc_doc/complib/cl_ioctl_h.html +./inc_docs/complib/cl_ioctl_h.html -Generated from ./inc/complib/cl_ioctl.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_ioctl.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

-

[Modules] +

[Modules] Component Library/IOCTL Object

-

[top][index]

+

[top][parent][index]

NAME

-
       IOCTL Object
+
       IOCTL Object
 

DESCRIPTION

       The IOCTL object provides functionality for handling IOCTL requests.
 
        The IOCTL object is only available in kernel mode and provides
        functionality for accessing information about IO requests initiated
-       by a user-mode application.  The IOCTL_CODE macro is used in both
+       by a user-mode application.  The IOCTL_CODE macro is used in both
        user and kernel mode to initiate and dispatch IOCTL requests, respectively.
 
        In Linux, in order for the IOCTL object to be used, requests must be
@@ -31,33 +31,33 @@ Component Library/IOCTL Object

SEE ALSO

       Structures:
-               cl_ioctl_handle_t
+               cl_ioctl_handle_t
 
        Callbacks:
-               cl_pfn_ioctl_handler_t
+               cl_pfn_ioctl_handler_t
 
        Control Code Generation
-               IOCTL_CODE
+               IOCTL_CODE
 
        Kernel Mode Access
-               cl_ioctl_process
-               cl_ioctl_complete
-               cl_ioctl_type
-               cl_ioctl_cmd
-               cl_ioctl_ctl_code
-               cl_ioctl_in_buf
-               cl_ioctl_in_size
-               cl_ioctl_out_buf
-               cl_ioctl_out_size
+               cl_ioctl_process
+               cl_ioctl_complete
+               cl_ioctl_type
+               cl_ioctl_cmd
+               cl_ioctl_ctl_code
+               cl_ioctl_in_buf
+               cl_ioctl_in_size
+               cl_ioctl_out_buf
+               cl_ioctl_out_size
 
        User Mode Access
-               cl_ioctl_request
-               cl_ioctl_result
+               cl_ioctl_request
+               cl_ioctl_result
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_cmd

[top][index]

@@ -70,7 +70,7 @@ Component Library: IOCTL Object/cl_ioctl_cmd

SYNOPSIS

CL_EXPORT uint16_t CL_API
 cl_ioctl_cmd(
-        IN      cl_ioctl_handle_t       h_ioctl );
+        IN      cl_ioctl_handle_t       h_ioctl );
 

PARAMETERS

       h_ioctl
@@ -84,12 +84,12 @@ Component Library: IOCTL Object/cl_ioctl_cmd
 
       The cl_ioctl_cmd function is only available in the kernel.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_type, cl_ioctl_ctl_code
+
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_type, cl_ioctl_ctl_code
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_complete

[top][index]

@@ -103,8 +103,8 @@ Component Library: IOCTL Object/cl_ioctl_complete

SYNOPSIS

CL_EXPORT void CL_API
 cl_ioctl_complete(
-        IN      cl_ioctl_handle_t       h_ioctl,
-        IN      cl_status_t                     io_status,
+        IN      cl_ioctl_handle_t       h_ioctl,
+        IN      cl_status_t                     io_status,
         IN      size_t                          ret_bytes );
 

PARAMETERS

@@ -122,12 +122,12 @@ Component Library: IOCTL Object/cl_ioctl_complete This function does not return a value.

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_process
+
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_process
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_ctl_code

[top][index]

@@ -140,7 +140,7 @@ Component Library: IOCTL Object/cl_ioctl_ctl_code

SYNOPSIS

CL_EXPORT uint32_t CL_API
 cl_ioctl_ctl_code(
-        IN      cl_ioctl_handle_t       h_ioctl );
+        IN      cl_ioctl_handle_t       h_ioctl );
 

PARAMETERS

       h_ioctl
@@ -154,12 +154,12 @@ Component Library: IOCTL Object/cl_ioctl_ctl_code
 
       The cl_ioctl_ctl_code function is only available in the kernel.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_type, cl_ioctl_cmd
+
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_type, cl_ioctl_cmd
 

-

[Definitions] +

[Definitions] Component Library: IOCTL Object/cl_ioctl_handle_t

[top][index]

@@ -175,14 +175,14 @@ Component Library: IOCTL Object/cl_ioctl_handle_t

varies from environment to environment.

SEE ALSO

-
       IOCTL Object, cl_ioctl_type, cl_ioctl_cmd, cl_ioctl_in_buf,
-       cl_ioctl_in_size, cl_ioctl_out_buf, cl_ioctl_out_size,
+
       IOCTL Object, cl_ioctl_type, cl_ioctl_cmd, cl_ioctl_in_buf,
+       cl_ioctl_in_size, cl_ioctl_out_buf, cl_ioctl_out_size,
        cl_ioctl_set_status, cl_ioctl_set_ret_bytes
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_in_buf

[top][index]

@@ -195,7 +195,7 @@ Component Library: IOCTL Object/cl_ioctl_in_buf

SYNOPSIS

CL_EXPORT void* CL_API
 cl_ioctl_in_buf(
-        IN      cl_ioctl_handle_t       h_ioctl );
+        IN      cl_ioctl_handle_t       h_ioctl );
 

PARAMETERS

       h_ioctl
@@ -211,13 +211,13 @@ Component Library: IOCTL Object/cl_ioctl_in_buf
        returned pointer points to the MDL describing the input buffer.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_in_size,
-       cl_ioctl_out_buf, cl_ioctl_out_size
+
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_in_size,
+       cl_ioctl_out_buf, cl_ioctl_out_size
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_in_size

[top][index]

@@ -230,7 +230,7 @@ Component Library: IOCTL Object/cl_ioctl_in_size

SYNOPSIS

CL_EXPORT ULONG CL_API
 cl_ioctl_in_size(
-        IN      cl_ioctl_handle_t       h_ioctl );
+        IN      cl_ioctl_handle_t       h_ioctl );
 

PARAMETERS

       h_ioctl
@@ -244,13 +244,13 @@ Component Library: IOCTL Object/cl_ioctl_in_size
 
       The cl_ioctl_in_size function is only available in the kernel.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_in_buf,
-       cl_ioctl_out_buf, cl_ioctl_out_size
+
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_in_buf,
+       cl_ioctl_out_buf, cl_ioctl_out_size
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_out_buf

[top][index]

@@ -263,7 +263,7 @@ Component Library: IOCTL Object/cl_ioctl_out_buf

SYNOPSIS

CL_EXPORT void* CL_API
 cl_ioctl_out_buf(
-        IN      cl_ioctl_handle_t       h_ioctl );
+        IN      cl_ioctl_handle_t       h_ioctl );
 

PARAMETERS

       h_ioctl
@@ -280,13 +280,13 @@ Component Library: IOCTL Object/cl_ioctl_out_buf
        the input buffer.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_out_size,
-       cl_ioctl_in_buf, cl_ioctl_in_size
+
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_out_size,
+       cl_ioctl_in_buf, cl_ioctl_in_size
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_out_size

[top][index]

@@ -299,7 +299,7 @@ Component Library: IOCTL Object/cl_ioctl_out_size

SYNOPSIS

CL_EXPORT ULONG CL_API
 cl_ioctl_out_size(
-        IN      cl_ioctl_handle_t       h_ioctl );
+        IN      cl_ioctl_handle_t       h_ioctl );
 

PARAMETERS

       h_ioctl
@@ -313,13 +313,13 @@ Component Library: IOCTL Object/cl_ioctl_out_size
 
       The cl_ioctl_out_size function is only available in the kernel.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_out_buf,
-       cl_ioctl_in_buf, cl_ioctl_in_size
+
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_out_buf,
+       cl_ioctl_in_buf, cl_ioctl_in_size
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_process

[top][index]

@@ -328,13 +328,13 @@ Component Library: IOCTL Object/cl_ioctl_process

DESCRIPTION

       The cl_ioctl_process function unpacks information initiated by a call to
-       cl_ioctl_request function and invokes a user-supplied callback.
+       cl_ioctl_request function and invokes a user-supplied callback.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_ioctl_process(
         IN      void                                    *p_ioctl,
-        IN      cl_pfn_ioctl_handler_t  pfn_ioctl_handler,
+        IN      cl_pfn_ioctl_handler_t  pfn_ioctl_handler,
         IN      void                                    *context_1,
         IN      void                                    *context_2 );
 
@@ -361,7 +361,7 @@ Component Library: IOCTL Object/cl_ioctl_process Other values to indicate various failures.

NOTES

-
       Users must call cl_ioctl_complete from within the handler if completing
+
       Users must call cl_ioctl_complete from within the handler if completing
        the IOCTL request synchronously.  If the IOCTL request's control code is
        invalid, the handler should return CL_INVALID_REQUEST.
 
@@ -374,12 +374,12 @@ Component Library: IOCTL Object/cl_ioctl_process
        parameter of the IOCTL entry point instead of a copy.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_pfn_ioctl_handler_t, cl_ioctl_complete
+
       IOCTL Object, cl_ioctl_handle_t, cl_pfn_ioctl_handler_t, cl_ioctl_complete
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_request

[top][index]

@@ -391,7 +391,7 @@ Component Library: IOCTL Object/cl_ioctl_request

requests to a device.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_ioctl_request(
         IN              void                    *h_dev,
         IN              uint32_t                ioctl_code,
@@ -434,12 +434,12 @@ Component Library: IOCTL Object/cl_ioctl_request
                exclusive of the p_ret_bytes parameter.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_result
+
       IOCTL Object, cl_ioctl_result
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_result

[top][index]

@@ -450,7 +450,7 @@ Component Library: IOCTL Object/cl_ioctl_result

       Checks the status of an asynchronous IOCTL request.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_ioctl_result(
         IN      void            *h_dev,
         IN      void            *p_async_info,
@@ -467,7 +467,7 @@ Component Library: IOCTL Object/cl_ioctl_result
                [in] For platforms that support asynchronous I/O, supplies a pointer
                to that platform's async I/O structure, if any.  For Windows, this
                is a pointer to an OVERLAPPED structure.  This must be the same
-               as that provided in the cl_ioctl_request function.
+               as that provided in the cl_ioctl_request function.
 
        p_ret_bytes
                [out] Number of bytes written to the output buffer.
@@ -485,12 +485,12 @@ Component Library: IOCTL Object/cl_ioctl_result
        Other status values to indicate errors.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_request
+
       IOCTL Object, cl_ioctl_request
 

-

[Functions] +

[Functions] Component Library: IOCTL Object/cl_ioctl_type

[top][index]

@@ -503,7 +503,7 @@ Component Library: IOCTL Object/cl_ioctl_type

SYNOPSIS

CL_EXPORT uint16_t CL_API
 cl_ioctl_type(
-        IN      cl_ioctl_handle_t       h_ioctl );
+        IN      cl_ioctl_handle_t       h_ioctl );
 

PARAMETERS

       h_ioctl
@@ -517,12 +517,12 @@ Component Library: IOCTL Object/cl_ioctl_type
 
       The cl_ioctl_type function is only available in the kernel.
 

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_cmd, cl_ioctl_ctl_code
+
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_cmd, cl_ioctl_ctl_code
 

-

[Definitions] +

[Definitions] Component Library: IOCTL Object/cl_pfn_ioctl_handler_t

[top][index]

@@ -532,12 +532,12 @@ Component Library: IOCTL Object/cl_pfn_ioctl_handler_t

DESCRIPTION

       The cl_pfn_ioctl_handler_t function type defines the prototype for
        IOCTL handlers used when handling IOCTL requests initiated by
-       cl_ioctl_request.
+       cl_ioctl_request.
 

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_ioctl_handler_t)(
-        IN      cl_ioctl_handle_t       h_ioctl,
+        IN      cl_ioctl_handle_t       h_ioctl,
         IN      void                            *context_1,
         IN      void                            *context_2 );
 
@@ -546,10 +546,10 @@ Component Library: IOCTL Object/cl_pfn_ioctl_handler_t [in] Handle to the IOCTL request. context_1 - [in] First context parameters, as provided to cl_ioctl_process. + [in] First context parameters, as provided to cl_ioctl_process. context_2 - [in] Second context parameters, as provided to cl_ioctl_process. + [in] Second context parameters, as provided to cl_ioctl_process. RETURN VALUES CL_SUCCESS if the IOCTL was completed successfully. @@ -563,12 +563,12 @@ Component Library: IOCTL Object/cl_pfn_ioctl_handler_t status in the output buffer.

SEE ALSO

-
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_process
+
       IOCTL Object, cl_ioctl_handle_t, cl_ioctl_process
 

-

[Definitions] +

[Definitions] Component Library: IOCTL Object/IOCTL_CODE

[top][index]

@@ -602,7 +602,7 @@ Component Library: IOCTL Object/IOCTL_CODE

result in FILE_ANY_ACCESS and METHOD_BUFFERED being specified.

SEE ALSO

-
       IOCTL Object, cl_dev_ioctl, cl_ioctl_type, cl_ioctl_cmd
+
       IOCTL Object, cl_dev_ioctl, cl_ioctl_type, cl_ioctl_cmd
 
diff --git a/trunk/docs/complib/cl_irqlock_h.html b/trunk/docs/complib/cl_irqlock_h.html index c58a367d..67008594 100644 --- a/trunk/docs/complib/cl_irqlock_h.html +++ b/trunk/docs/complib/cl_irqlock_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_irqlock_h.html +./inc_docs/complib/cl_irqlock_h.html -Generated from ./inc/complib/cl_irqlock.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_irqlock.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] +

[Modules] Component Library/Irqlock

-

[top][index]

+

[top][parent][index]

NAME

       Irqlock
 
@@ -31,15 +31,15 @@ Component Library/Irqlock

cl_irqlock_t Initialization: - cl_irqlock_construct, cl_irqlock_init, cl_irqlock_destroy + cl_irqlock_construct, cl_irqlock_init, cl_irqlock_destroy Manipulation - cl_irqlock_acquire, cl_irqlock_release + cl_irqlock_acquire, cl_irqlock_release

-

[Functions] +

[Functions] Component Library: Irqlock/cl_irqlock_acquire

[top][index]

@@ -66,12 +66,12 @@ Component Library: Irqlock/cl_irqlock_acquire

       This function does not return a value.
 

SEE ALSO

-
       Irqlock, cl_irqlock_release
+
       Irqlock, cl_irqlock_release
 

-

[Functions] +

[Functions] Component Library: Irqlock/cl_irqlock_construct

[top][index]

@@ -95,19 +95,19 @@ Component Library: Irqlock/cl_irqlock_construct

       This function does not return a value.
 

NOTES

-
       Allows calling cl_irqlock_destroy without first calling 
-       cl_irqlock_init.
+
       Allows calling cl_irqlock_destroy without first calling 
+       cl_irqlock_init.
 
        Calling cl_irqlock_construct is a prerequisite to calling any other
-       IRQ lock function except cl_irqlock_init.
+       IRQ lock function except cl_irqlock_init.
 

SEE ALSO

-
       Irqlock, cl_irqlock_init, cl_irqlock_destroy
+
       Irqlock, cl_irqlock_init, cl_irqlock_destroy
 

-

[Functions] +

[Functions] Component Library: Irqlock/cl_irqlock_destroy

[top][index]

@@ -132,16 +132,16 @@ Component Library: Irqlock/cl_irqlock_destroy

NOTES

       Performs any necessary cleanup of a IRQ lock. This function must only 
-       be called if either cl_irqlock_construct or cl_irqlock_init has been 
+       be called if either cl_irqlock_construct or cl_irqlock_init has been 
        called.
 

SEE ALSO

-
       Irqlock, cl_irqlock_construct, cl_irqlock_init
+
       Irqlock, cl_irqlock_construct, cl_irqlock_init
 

-

[Functions] +

[Functions] Component Library: Irqlock/cl_irqlock_init

[top][index]

@@ -152,7 +152,7 @@ Component Library: Irqlock/cl_irqlock_init

       The cl_irqlock_init function initializes a IRQ lock for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_irqlock_init( 
         IN      cl_irqlock_t* const             p_irqlock,
         IN      cl_interrupt_t* const   p_interrupt );
@@ -169,12 +169,12 @@ Component Library: Irqlock/cl_irqlock_init
        CL_SUCCESS if initialization succeeded.
 
        CL_ERROR if initialization failed. Callers should call 
-       cl_irqlock_destroy to clean up any resources allocated during 
+       cl_irqlock_destroy to clean up any resources allocated during 
        initialization.
 

NOTES

       Initialize the IRQ lock structure. Allows calling cl_irqlock_aquire 
-       and cl_irqlock_release.
+       and cl_irqlock_release.
 
        In Linux, the p_interrupt parameter is currently ignored.
 
@@ -182,13 +182,13 @@ Component Library: Irqlock/cl_irqlock_init
        the value of which is supplied by a call to IoConnectInterrupt.
 

SEE ALSO

-
       Irqlock, cl_irqlock_construct, cl_irqlock_destroy, 
-       cl_irqlock_acquire, cl_irqlock_release
+
       Irqlock, cl_irqlock_construct, cl_irqlock_destroy, 
+       cl_irqlock_acquire, cl_irqlock_release
 

-

[Functions] +

[Functions] Component Library: Irqlock/cl_irqlock_release

[top][index]

@@ -211,10 +211,10 @@ Component Library: Irqlock/cl_irqlock_release

       This function does not return a value.
 

NOTES

-
       Releases a IRQ lock after a call to cl_irqlock_acquire.
+
       Releases a IRQ lock after a call to cl_irqlock_acquire.
 

SEE ALSO

-
       Irqlock, cl_irqlock_acquire
+
       Irqlock, cl_irqlock_acquire
 
diff --git a/trunk/docs/complib/cl_list_h.html b/trunk/docs/complib/cl_list_h.html index 4887f1a8..c99eec33 100644 --- a/trunk/docs/complib/cl_list_h.html +++ b/trunk/docs/complib/cl_list_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_list_h.html +./inc_docs/complib/cl_list_h.html -Generated from ./inc/complib/cl_list.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_list.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] +

[Modules] Component Library/List

-

[top][index]

+

[top][parent][index]

NAME

       List
 
@@ -22,52 +22,52 @@ Component Library/List

       List stores objects in a doubly linked list.
 
        Unlike quick list, users pass pointers to the object being stored, rather
-       than to a cl_list_item_t structure.  Insertion operations on a list can
+       than to a cl_list_item_t structure.  Insertion operations on a list can
        fail, and callers should trap for such failures.
 
        Use quick list in situations where insertion failures cannot be tolerated.
 
        List is not thread safe, and users must provide serialization.
 
-       The list functions operates on a cl_list_t structure which should be
+       The list functions operates on a cl_list_t structure which should be
        treated as opaque and should be manipulated only through the provided
        functions.
 

SEE ALSO

       Types:
-               cl_list_iterator_t
+               cl_list_iterator_t
 
        Structures:
-               cl_list_t
+               cl_list_t
 
        Callbacks:
-               cl_pfn_list_apply_t, cl_pfn_list_find_t
+               cl_pfn_list_apply_t, cl_pfn_list_find_t
 
        Initialization/Destruction:
-               cl_list_construct, cl_list_init, cl_list_destroy
+               cl_list_construct, cl_list_init, cl_list_destroy
 
        Iteration:
-               cl_list_next, cl_list_prev, cl_list_head, cl_list_tail,
-               cl_list_end
+               cl_list_next, cl_list_prev, cl_list_head, cl_list_tail,
+               cl_list_end
 
        Manipulation:
-               cl_list_insert_head, cl_list_insert_tail,
-               cl_list_insert_array_head, cl_list_insert_array_tail,
-               cl_list_insert_prev, cl_list_insert_next,
-               cl_list_remove_head, cl_list_remove_tail,
-               cl_list_remove_object, cl_list_remove_item, cl_list_remove_all
+               cl_list_insert_head, cl_list_insert_tail,
+               cl_list_insert_array_head, cl_list_insert_array_tail,
+               cl_list_insert_prev, cl_list_insert_next,
+               cl_list_remove_head, cl_list_remove_tail,
+               cl_list_remove_object, cl_list_remove_item, cl_list_remove_all
 
        Search:
-               cl_is_object_in_list, cl_list_find_from_head, cl_list_find_from_tail,
-               cl_list_apply_func
+               cl_is_object_in_list, cl_list_find_from_head, cl_list_find_from_tail,
+               cl_list_apply_func
 
        Attributes:
-               cl_list_count, cl_is_list_empty, cl_is_list_inited
+               cl_list_count, cl_is_list_empty, cl_is_list_inited
 

-

[Functions] +

[Functions] Component Library: List/cl_is_list_empty

[top][index]

@@ -80,16 +80,16 @@ Component Library: List/cl_is_list_empty

SYNOPSIS

CL_INLINE boolean_t CL_API
 cl_is_list_empty(
-        IN      const cl_list_t* const  p_list )
+        IN      const cl_list_t* const  p_list )
 {
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
-        return( cl_is_qlist_empty( &p_list->list ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        return( cl_is_qlist_empty( &p_list->list ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure.
+               [in] Pointer to a cl_list_t structure.
 
  RETURN VALUES
        TRUE if the specified list is empty.
@@ -97,12 +97,12 @@ Component Library: List/cl_is_list_empty
        FALSE otherwise.
 

SEE ALSO

-
       List, cl_list_count, cl_list_remove_all
+
       List, cl_list_count, cl_list_remove_all
 

-

[Functions] +

[Functions] Component Library: List/cl_is_list_inited

[top][index]

@@ -116,7 +116,7 @@ Component Library: List/cl_is_list_inited

SYNOPSIS

CL_INLINE boolean_t CL_API
 cl_is_list_inited(
-        IN      const cl_list_t* const  p_list )
+        IN      const cl_list_t* const  p_list )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
@@ -124,12 +124,12 @@ Component Library: List/cl_is_list_inited
          * The pool is the last thing initialized.  If it is initialized, the
          * list is initialized too.
          */
-        return( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        return( cl_is_qpool_inited( &p_list->list_item_pool ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure whose initilization state
+               [in] Pointer to a cl_list_t structure whose initilization state
                to check.
 
  RETURN VALUES
@@ -142,12 +142,12 @@ Component Library: List/cl_is_list_inited
        member functions is appropriate.
 

SEE ALSO

-
       List
+
       List
 

-

[Functions] +

[Functions] Component Library: List/cl_is_object_in_list

[top][index]

@@ -161,12 +161,12 @@ Component Library: List/cl_is_object_in_list

SYNOPSIS

CL_EXPORT boolean_t CL_API
 cl_is_object_in_list(
-        IN      const cl_list_t* const  p_list,
+        IN      const cl_list_t* const  p_list,
         IN      const void* const               p_object );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure in which to look for the object.
+               [in] Pointer to a cl_list_t structure in which to look for the object.
 
        p_object
                [in] Pointer to an object stored in a list.
@@ -177,12 +177,12 @@ Component Library: List/cl_is_object_in_list
        FALSE otherwise.
 

SEE ALSO

-
       List
+
       List
 

-

[Functions] +

[Functions] Component Library: List/cl_list_apply_func

[top][index]

@@ -196,17 +196,17 @@ Component Library: List/cl_list_apply_func

SYNOPSIS

CL_EXPORT void CL_API
 cl_list_apply_func(
-        IN      const cl_list_t* const  p_list,
-        IN      cl_pfn_list_apply_t             pfn_func,
+        IN      const cl_list_t* const  p_list,
+        IN      cl_pfn_list_apply_t             pfn_func,
         IN      const void* const               context );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure to iterate.
+               [in] Pointer to a cl_list_t structure to iterate.
 
        pfn_func
                [in] Function invoked for every item in a list.
-               See the cl_pfn_list_apply_t function type declaration for details
+               See the cl_pfn_list_apply_t function type declaration for details
                about the callback function.
 
        context
@@ -222,13 +222,13 @@ Component Library: List/cl_list_apply_func
        would corrupt the list.
 

SEE ALSO

-
       List, cl_list_find_from_head, cl_list_find_from_tail,
-       cl_pfn_list_apply_t
+
       List, cl_list_find_from_head, cl_list_find_from_tail,
+       cl_pfn_list_apply_t
 

-

[Functions] +

[Functions] Component Library: List/cl_list_construct

[top][index]

@@ -241,28 +241,28 @@ Component Library: List/cl_list_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_list_construct(
-        IN      cl_list_t* const        p_list );
+        IN      cl_list_t* const        p_list );
 

PARAMETERS

       p_list
-               [in] Pointer to cl_list_t object whose state to initialize.
+               [in] Pointer to cl_list_t object whose state to initialize.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       Allows calling cl_list_init, cl_list_destroy and cl_is_list_inited.
+
       Allows calling cl_list_init, cl_list_destroy and cl_is_list_inited.
 
        Calling cl_list_construct is a prerequisite to calling any other
-       list function except cl_list_init.
+       list function except cl_list_init.
 

SEE ALSO

-
       List, cl_list_init, cl_list_destroy, cl_is_list_inited
+
       List, cl_list_init, cl_list_destroy, cl_is_list_inited
 

-

[Functions] +

[Functions] Component Library: List/cl_list_count

[top][index]

@@ -275,28 +275,28 @@ Component Library: List/cl_list_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_list_count(
-        IN      const cl_list_t* const  p_list )
+        IN      const cl_list_t* const  p_list )
 {
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
-        return( cl_qlist_count( &p_list->list ) );
+        return( cl_qlist_count( &p_list->list ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure whose object to count.
+               [in] Pointer to a cl_list_t structure whose object to count.
 
  RETURN VALUES
        Number of objects stored in the specified list.
 

SEE ALSO

-
       List
+
       List
 

-

[Functions] +

[Functions] Component Library: List/cl_list_destroy

[top][index]

@@ -309,11 +309,11 @@ Component Library: List/cl_list_destroy

SYNOPSIS

CL_EXPORT void CL_API
 cl_list_destroy(
-        IN      cl_list_t* const        p_list );
+        IN      cl_list_t* const        p_list );
 

PARAMETERS

       p_list
-               [in] Pointer to cl_list_t structure to destroy.
+               [in] Pointer to cl_list_t structure to destroy.
 

RETURN VALUE

       This function does not return a value.
@@ -323,18 +323,18 @@ Component Library: List/cl_list_destroy
        but does release all memory allocated internally.  Further operations
        should not be attempted on the list after cl_list_destroy is invoked.
 
-       This function should only be called after a call to cl_list_construct
-       or cl_list_init.
+       This function should only be called after a call to cl_list_construct
+       or cl_list_init.
 
        In debug builds, cl_list_destroy asserts if the list is not empty.
 

SEE ALSO

-
       List, cl_list_construct, cl_list_init
+
       List, cl_list_construct, cl_list_init
 

-

[Functions] +

[Functions] Component Library: List/cl_list_end

[top][index]

@@ -346,36 +346,36 @@ Component Library: List/cl_list_end

the end of a list.

SYNOPSIS

-
CL_INLINE const cl_list_iterator_t CL_API
+
CL_INLINE const cl_list_iterator_t CL_API
 cl_list_end(
-        IN      const cl_list_t* const  p_list )
+        IN      const cl_list_t* const  p_list )
 {
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
-        return( cl_qlist_end( &p_list->list ) );
+        return( cl_qlist_end( &p_list->list ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure for which the iterator for the
+               [in] Pointer to a cl_list_t structure for which the iterator for the
                object at the head is to be returned.
 

RETURN VALUE

-
       cl_list_iterator_t for the end of the list.
+
       cl_list_iterator_t for the end of the list.
 

NOTES

-
       Use cl_list_obj to retrieve the object associated with the
-       returned cl_list_iterator_t.
+
       Use cl_list_obj to retrieve the object associated with the
+       returned cl_list_iterator_t.
 

SEE ALSO

-
       List, cl_list_head, cl_list_tail, cl_list_next, cl_list_prev,
-       cl_list_obj
+
       List, cl_list_head, cl_list_tail, cl_list_next, cl_list_prev,
+       cl_list_obj
 

-

[Functions] +

[Functions] Component Library: List/cl_list_find_from_head

[top][index]

@@ -387,19 +387,19 @@ Component Library: List/cl_list_find_from_head

to search for an object starting from the head of a list.

SYNOPSIS

-
CL_EXPORT const cl_list_iterator_t CL_API
+
CL_EXPORT const cl_list_iterator_t CL_API
 cl_list_find_from_head(
-        IN      const cl_list_t* const  p_list,
-        IN      cl_pfn_list_find_t              pfn_func,
+        IN      const cl_list_t* const  p_list,
+        IN      cl_pfn_list_find_t              pfn_func,
         IN      const void* const               context );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure to search.
+               [in] Pointer to a cl_list_t structure to search.
 
        pfn_func
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_list_find_t function type declaration for details
+               See the cl_pfn_list_find_t function type declaration for details
                about the callback function.
 
        context
@@ -418,13 +418,13 @@ Component Library: List/cl_list_find_from_head
        operations as these would corrupt the list.
 

SEE ALSO

-
       List, cl_list_find_from_tail, cl_list_apply_func,
-       cl_pfn_list_find_t
+
       List, cl_list_find_from_tail, cl_list_apply_func,
+       cl_pfn_list_find_t
 

-

[Functions] +

[Functions] Component Library: List/cl_list_find_from_tail

[top][index]

@@ -436,19 +436,19 @@ Component Library: List/cl_list_find_from_tail

to search for an object starting from the tail of a list.

SYNOPSIS

-
CL_EXPORT const cl_list_iterator_t CL_API
+
CL_EXPORT const cl_list_iterator_t CL_API
 cl_list_find_from_tail(
-        IN      const cl_list_t* const  p_list,
-        IN      cl_pfn_list_find_t              pfn_func,
+        IN      const cl_list_t* const  p_list,
+        IN      cl_pfn_list_find_t              pfn_func,
         IN      const void* const               context );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure to search.
+               [in] Pointer to a cl_list_t structure to search.
 
        pfn_func
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_list_find_t function type declaration for details
+               See the cl_pfn_list_find_t function type declaration for details
                about the callback function.
 
        context
@@ -467,13 +467,13 @@ Component Library: List/cl_list_find_from_tail
        operations as these would corrupt the list.
 

SEE ALSO

-
       List, cl_list_find_from_head, cl_list_apply_func,
-       cl_pfn_list_find_t
+
       List, cl_list_find_from_head, cl_list_apply_func,
+       cl_pfn_list_find_t
 

-

[Functions] +

[Functions] Component Library: List/cl_list_head

[top][index]

@@ -485,38 +485,38 @@ Component Library: List/cl_list_head

the head of a list.

SYNOPSIS

-
CL_INLINE const cl_list_iterator_t CL_API
+
CL_INLINE const cl_list_iterator_t CL_API
 cl_list_head(
-        IN      const cl_list_t* const  p_list )
+        IN      const cl_list_t* const  p_list )
 {
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
-        return( cl_qlist_head( &p_list->list ) );
+        return( cl_qlist_head( &p_list->list ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure for which the iterator for the
+               [in] Pointer to a cl_list_t structure for which the iterator for the
                object at the head is to be returned.
 
  RETURN VALUES
-       cl_list_iterator_t for the head of the list.
+       cl_list_iterator_t for the head of the list.
 
-       cl_list_iterator_t for the end of the list if the list is empty.
+       cl_list_iterator_t for the end of the list if the list is empty.
 

NOTES

-
       Use cl_list_obj to retrieve the object associated with the
-       returned cl_list_iterator_t.
+
       Use cl_list_obj to retrieve the object associated with the
+       returned cl_list_iterator_t.
 

SEE ALSO

-
       List, cl_list_tail, cl_list_next, cl_list_prev, cl_list_end,
-       cl_list_obj
+
       List, cl_list_tail, cl_list_next, cl_list_prev, cl_list_end,
+       cl_list_obj
 

-

[Functions] +

[Functions] Component Library: List/cl_list_init

[top][index]

@@ -527,14 +527,14 @@ Component Library: List/cl_list_init

       The cl_list_init function initializes a list for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_list_init(
-        IN      cl_list_t* const        p_list,
+        IN      cl_list_t* const        p_list,
         IN      const size_t            min_items );
 

PARAMETERS

       p_list
-               [in] Pointer to cl_list_t structure to initialize.
+               [in] Pointer to cl_list_t structure to initialize.
 
        min_items
                [in] Minimum number of items that can be stored.  All necessary
@@ -551,13 +551,13 @@ Component Library: List/cl_list_init
        by the min_items parameter.
 

SEE ALSO

-
       List, cl_list_construct, cl_list_destroy, cl_list_insert_head,
-       cl_list_insert_tail, cl_list_remove_head, cl_list_remove_tail
+
       List, cl_list_construct, cl_list_destroy, cl_list_insert_head,
+       cl_list_insert_tail, cl_list_remove_head, cl_list_remove_tail
 

-

[Functions] +

[Functions] Component Library: List/cl_list_insert_array_head

[top][index]

@@ -569,16 +569,16 @@ Component Library: List/cl_list_insert_array_head

at the head of a list.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_list_insert_array_head(
-        IN      cl_list_t* const        p_list,
+        IN      cl_list_t* const        p_list,
         IN      const void* const       p_array,
         IN      uint32_t                        item_count,
         IN      const uint32_t          item_size );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure into which to insert the objects.
+               [in] Pointer to a cl_list_t structure into which to insert the objects.
 
        p_array
                [in] Pointer to the first object in an array.
@@ -598,17 +598,17 @@ Component Library: List/cl_list_insert_array_head
 

NOTES

       Inserts all objects in the array to the head of the list, preserving the
        ordering of the objects.  If not successful, no items are added.
-       List insertion operations are guaranteed to work for the minimum number
-       of items as specified in cl_list_init by the min_items parameter.
+       List insertion operations are guaranteed to work for the minimum number
+       of items as specified in cl_list_init by the min_items parameter.
 

SEE ALSO

-
       List, cl_list_insert_array_tail, cl_list_insert_head, cl_list_insert_tail,
-       cl_list_insert_prev, cl_list_insert_next
+
       List, cl_list_insert_array_tail, cl_list_insert_head, cl_list_insert_tail,
+       cl_list_insert_prev, cl_list_insert_next
 

-

[Functions] +

[Functions] Component Library: List/cl_list_insert_array_tail

[top][index]

@@ -620,16 +620,16 @@ Component Library: List/cl_list_insert_array_tail

at the tail of a list.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_list_insert_array_tail(
-        IN      cl_list_t* const        p_list,
+        IN      cl_list_t* const        p_list,
         IN      const void* const       p_array,
         IN      uint32_t                        item_count,
         IN      const uint32_t          item_size);
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure into which to insert the objects.
+               [in] Pointer to a cl_list_t structure into which to insert the objects.
 
        p_array
                [in] Pointer to the first object in an array.
@@ -649,17 +649,17 @@ Component Library: List/cl_list_insert_array_tail
 

NOTES

       Inserts all objects in the array to the tail of the list, preserving the
        ordering of the objects.  If not successful, no items are added.
-       List insertion operations are guaranteed to work for the minimum number
-       of items as specified in cl_list_init by the min_items parameter.
+       List insertion operations are guaranteed to work for the minimum number
+       of items as specified in cl_list_init by the min_items parameter.
 

SEE ALSO

-
       List, cl_list_insert_array_head, cl_list_insert_head, cl_list_insert_tail,
-       cl_list_insert_prev, cl_list_insert_next
+
       List, cl_list_insert_array_head, cl_list_insert_head, cl_list_insert_tail,
+       cl_list_insert_prev, cl_list_insert_next
 

-

[Functions] +

[Functions] Component Library: List/cl_list_insert_head

[top][index]

@@ -670,29 +670,29 @@ Component Library: List/cl_list_insert_head

       The cl_list_insert_head function inserts an object at the head of a list.
 

SYNOPSIS

-
CL_INLINE cl_status_t CL_API
+
CL_INLINE cl_status_t CL_API
 cl_list_insert_head(
-        IN      cl_list_t* const        p_list,
+        IN      cl_list_t* const        p_list,
         IN      const void* const       p_object )
 {
         cl_pool_obj_t   *p_pool_obj;
 
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
         /* Get a list item to add to the list. */
-        p_pool_obj = (cl_pool_obj_t*)cl_qpool_get( &p_list->list_item_pool );
+        p_pool_obj = (cl_pool_obj_t*)cl_qpool_get( &p_list->list_item_pool );
         if( !p_pool_obj )
                 return( CL_INSUFFICIENT_MEMORY );
 
         p_pool_obj->list_obj.p_object = p_object;
-        cl_qlist_insert_head( &p_list->list, &p_pool_obj->list_obj.list_item );
+        cl_qlist_insert_head( &p_list->list, &p_pool_obj->list_obj.list_item );
         return( CL_SUCCESS );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure into which to insert the object.
+               [in] Pointer to a cl_list_t structure into which to insert the object.
 
        p_object
                [in] Pointer to an object to insert into the list.
@@ -703,19 +703,19 @@ Component Library: List/cl_list_insert_head
        CL_INSUFFICIENT_MEMORY if there was not enough memory for the insertion.
 

NOTES

-
       Inserts the specified object at the head of the list.  List insertion
+
       Inserts the specified object at the head of the list.  List insertion
        operations are guaranteed to work for the minimum number of items as
-       specified in cl_list_init by the min_items parameter.
+       specified in cl_list_init by the min_items parameter.
 

SEE ALSO

-
       List, cl_list_insert_tail, cl_list_insert_array_head,
-       cl_list_insert_array_tail, cl_list_insert_prev, cl_list_insert_next,
-       cl_list_remove_head
+
       List, cl_list_insert_tail, cl_list_insert_array_head,
+       cl_list_insert_array_tail, cl_list_insert_prev, cl_list_insert_next,
+       cl_list_remove_head
 

-

[Functions] +

[Functions] Component Library: List/cl_list_insert_next

[top][index]

@@ -727,35 +727,35 @@ Component Library: List/cl_list_insert_next

the object associated with a given iterator.

SYNOPSIS

-
CL_INLINE cl_status_t CL_API
+
CL_INLINE cl_status_t CL_API
 cl_list_insert_next(
-        IN      cl_list_t* const                        p_list,
-        IN      const cl_list_iterator_t        iterator,
+        IN      cl_list_t* const                        p_list,
+        IN      const cl_list_iterator_t        iterator,
         IN      const void* const                       p_object )
 {
         cl_pool_obj_t   *p_pool_obj;
 
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
         /* Get a list item to add to the list. */
-        p_pool_obj = (cl_pool_obj_t*)cl_qpool_get( &p_list->list_item_pool );
+        p_pool_obj = (cl_pool_obj_t*)cl_qpool_get( &p_list->list_item_pool );
         if( !p_pool_obj )
                 return( CL_INSUFFICIENT_MEMORY );
 
         p_pool_obj->list_obj.p_object = p_object;
-        cl_qlist_insert_next( &p_list->list, (cl_list_item_t*)iterator,
+        cl_qlist_insert_next( &p_list->list, (cl_list_item_t*)iterator,
                 &p_pool_obj->list_obj.list_item );
         return( CL_SUCCESS );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure into which to insert the object.
+               [in] Pointer to a cl_list_t structure into which to insert the object.
 
        iterator
-               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
-               cl_list_tail, cl_list_next, or cl_list_prev.
+               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
+               cl_list_tail, cl_list_next, or cl_list_prev.
 
        p_object
                [in] Pointer to an object to insert into the list.
@@ -766,13 +766,13 @@ Component Library: List/cl_list_insert_next
        CL_INSUFFICIENT_MEMORY if there was not enough memory for the insertion.
 

SEE ALSO

-
       List, cl_list_insert_prev, cl_list_insert_head, cl_list_insert_tail,
-       cl_list_insert_array_head, cl_list_insert_array_tail
+
       List, cl_list_insert_prev, cl_list_insert_head, cl_list_insert_tail,
+       cl_list_insert_array_head, cl_list_insert_array_tail
 

-

[Functions] +

[Functions] Component Library: List/cl_list_insert_prev

[top][index]

@@ -784,35 +784,35 @@ Component Library: List/cl_list_insert_prev

the object associated with a given iterator.

SYNOPSIS

-
CL_INLINE cl_status_t CL_API
+
CL_INLINE cl_status_t CL_API
 cl_list_insert_prev(
-        IN      cl_list_t* const                        p_list,
-        IN      const cl_list_iterator_t        iterator,
+        IN      cl_list_t* const                        p_list,
+        IN      const cl_list_iterator_t        iterator,
         IN      const void* const                       p_object )
 {
         cl_pool_obj_t   *p_pool_obj;
 
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
         /* Get a list item to add to the list. */
-        p_pool_obj = (cl_pool_obj_t*)cl_qpool_get( &p_list->list_item_pool );
+        p_pool_obj = (cl_pool_obj_t*)cl_qpool_get( &p_list->list_item_pool );
         if( !p_pool_obj )
                 return( CL_INSUFFICIENT_MEMORY );
 
         p_pool_obj->list_obj.p_object = p_object;
-        cl_qlist_insert_prev( &p_list->list, (cl_list_item_t*)iterator,
+        cl_qlist_insert_prev( &p_list->list, (cl_list_item_t*)iterator,
                 &p_pool_obj->list_obj.list_item );
         return( CL_SUCCESS );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure into which to insert the object.
+               [in] Pointer to a cl_list_t structure into which to insert the object.
 
        iterator
-               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
-               cl_list_tail, cl_list_next, or cl_list_prev.
+               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
+               cl_list_tail, cl_list_next, or cl_list_prev.
 
        p_object
                [in] Pointer to an object to insert into the list.
@@ -823,13 +823,13 @@ Component Library: List/cl_list_insert_prev
        CL_INSUFFICIENT_MEMORY if there was not enough memory for the insertion.
 

SEE ALSO

-
       List, cl_list_insert_next, cl_list_insert_head, cl_list_insert_tail,
-       cl_list_insert_array_head, cl_list_insert_array_tail
+
       List, cl_list_insert_next, cl_list_insert_head, cl_list_insert_tail,
+       cl_list_insert_array_head, cl_list_insert_array_tail
 

-

[Functions] +

[Functions] Component Library: List/cl_list_insert_tail

[top][index]

@@ -840,29 +840,29 @@ Component Library: List/cl_list_insert_tail

       The cl_list_insert_tail function inserts an object at the head of a list.
 

SYNOPSIS

-
CL_INLINE cl_status_t CL_API
+
CL_INLINE cl_status_t CL_API
 cl_list_insert_tail(
-        IN      cl_list_t* const        p_list,
+        IN      cl_list_t* const        p_list,
         IN      const void* const       p_object )
 {
         cl_pool_obj_t   *p_pool_obj;
 
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
         /* Get a list item to add to the list. */
-        p_pool_obj = (cl_pool_obj_t*)cl_qpool_get( &p_list->list_item_pool );
+        p_pool_obj = (cl_pool_obj_t*)cl_qpool_get( &p_list->list_item_pool );
         if( !p_pool_obj )
                 return( CL_INSUFFICIENT_MEMORY );
 
         p_pool_obj->list_obj.p_object = p_object;
-        cl_qlist_insert_tail( &p_list->list, &p_pool_obj->list_obj.list_item );
+        cl_qlist_insert_tail( &p_list->list, &p_pool_obj->list_obj.list_item );
         return( CL_SUCCESS );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure into which to insert the object.
+               [in] Pointer to a cl_list_t structure into which to insert the object.
 
        p_object
                [in] Pointer to an object to insert into the list.
@@ -873,19 +873,19 @@ Component Library: List/cl_list_insert_tail
        CL_INSUFFICIENT_MEMORY if there was not enough memory for the insertion.
 

NOTES

-
       Inserts the specified object at the tail of the list.  List insertion
+
       Inserts the specified object at the tail of the list.  List insertion
        operations are guaranteed to work for the minimum number of items as
-       specified in cl_list_init by the min_items parameter.
+       specified in cl_list_init by the min_items parameter.
 

SEE ALSO

-
       List, cl_list_insert_head, cl_list_insert_array_head,
-       cl_list_insert_array_tail, cl_list_insert_prev, cl_list_insert_next,
-       cl_list_remove_tail
+
       List, cl_list_insert_head, cl_list_insert_array_head,
+       cl_list_insert_array_tail, cl_list_insert_prev, cl_list_insert_next,
+       cl_list_remove_tail
 

-

[Definitions] +

[Definitions] Component Library: List/cl_list_iterator_t

[top][index]

@@ -896,19 +896,19 @@ Component Library: List/cl_list_iterator_t

       Iterator type used to walk a list.
 

SYNOPSIS

-
typedef const cl_list_item_t *cl_list_iterator_t;
+
typedef const cl_list_item_t *cl_list_iterator_t;
 

NOTES

       The iterator should be treated as opaque to prevent corrupting the list.
 

SEE ALSO

-
       List, cl_list_head, cl_list_tail, cl_list_next, cl_list_prev,
-       cl_list_obj
+
       List, cl_list_head, cl_list_tail, cl_list_next, cl_list_prev,
+       cl_list_obj
 

-

[Functions] +

[Functions] Component Library: List/cl_list_next

[top][index]

@@ -920,42 +920,42 @@ Component Library: List/cl_list_next

in a list after the object associated with a given list iterator.

SYNOPSIS

-
CL_INLINE const cl_list_iterator_t CL_API
+
CL_INLINE const cl_list_iterator_t CL_API
 cl_list_next(
-        IN      const cl_list_iterator_t        iterator )
+        IN      const cl_list_iterator_t        iterator )
 {
         CL_ASSERT( iterator );
 
-        return( cl_qlist_next( iterator ) );
+        return( cl_qlist_next( iterator ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure for which the iterator for the
+               [in] Pointer to a cl_list_t structure for which the iterator for the
                next object is to be returned.
 
        iterator
-               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
-               cl_list_tail, cl_list_next, or cl_list_prev.
+               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
+               cl_list_tail, cl_list_next, or cl_list_prev.
 
  RETURN VALUES
-       cl_list_iterator_t for the object following the object associated with
+       cl_list_iterator_t for the object following the object associated with
        the list iterator specified by the iterator parameter.
 
-       cl_list_iterator_t for the end of the list if the list is empty.
+       cl_list_iterator_t for the end of the list if the list is empty.
 

NOTES

-
       Use cl_list_obj to retrieve the object associated with the
-       returned cl_list_iterator_t.
+
       Use cl_list_obj to retrieve the object associated with the
+       returned cl_list_iterator_t.
 

SEE ALSO

-
       List, cl_list_prev, cl_list_head, cl_list_tail, cl_list_end,
-       cl_list_obj
+
       List, cl_list_prev, cl_list_head, cl_list_tail, cl_list_end,
+       cl_list_obj
 

-

[Functions] +

[Functions] Component Library: List/cl_list_obj

[top][index]

@@ -969,7 +969,7 @@ Component Library: List/cl_list_obj

SYNOPSIS

CL_INLINE void* CL_API
 cl_list_obj(
-        IN      const cl_list_iterator_t        iterator )
+        IN      const cl_list_iterator_t        iterator )
 {
         CL_ASSERT( iterator );
 
@@ -978,20 +978,20 @@ Component Library: List/cl_list_obj
 

PARAMETERS

       iterator
-               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
-               cl_list_tail, cl_list_next, or cl_list_prev whose object is requested.
+               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
+               cl_list_tail, cl_list_next, or cl_list_prev whose object is requested.
 

RETURN VALUE

       Pointer to the object associated with the list iterator specified
        by the iterator parameter.
 

SEE ALSO

-
       List, cl_list_head, cl_list_tail, cl_list_next, cl_list_prev
+
       List, cl_list_head, cl_list_tail, cl_list_next, cl_list_prev
 

-

[Functions] +

[Functions] Component Library: List/cl_list_prev

[top][index]

@@ -1003,42 +1003,42 @@ Component Library: List/cl_list_prev

in a list before the object associated with a given list iterator.

SYNOPSIS

-
CL_INLINE const cl_list_iterator_t CL_API
+
CL_INLINE const cl_list_iterator_t CL_API
 cl_list_prev(
-        IN      const cl_list_iterator_t        iterator )
+        IN      const cl_list_iterator_t        iterator )
 {
         CL_ASSERT( iterator );
 
-        return( cl_qlist_prev( iterator ) );
+        return( cl_qlist_prev( iterator ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure for which the iterator for the
+               [in] Pointer to a cl_list_t structure for which the iterator for the
                next object is to be returned.
 
        iterator
-               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
-               cl_list_tail, cl_list_next, or cl_list_prev.
+               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
+               cl_list_tail, cl_list_next, or cl_list_prev.
 
  RETURN VALUES
-       cl_list_iterator_t for the object preceding the object associated with
+       cl_list_iterator_t for the object preceding the object associated with
        the list iterator specified by the iterator parameter.
 
-       cl_list_iterator_t for the end of the list if the list is empty.
+       cl_list_iterator_t for the end of the list if the list is empty.
 

NOTES

-
       Use cl_list_obj to retrieve the object associated with the
-       returned cl_list_iterator_t.
+
       Use cl_list_obj to retrieve the object associated with the
+       returned cl_list_iterator_t.
 

SEE ALSO

-
       List, cl_list_next, cl_list_head, cl_list_tail, cl_list_end,
-       cl_list_obj
+
       List, cl_list_next, cl_list_head, cl_list_tail, cl_list_end,
+       cl_list_obj
 

-

[Functions] +

[Functions] Component Library: List/cl_list_remove_all

[top][index]

@@ -1052,30 +1052,30 @@ Component Library: List/cl_list_remove_all

SYNOPSIS

CL_INLINE void CL_API
 cl_list_remove_all(
-        IN      cl_list_t* const        p_list )
+        IN      cl_list_t* const        p_list )
 {
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
         /* Return all the list items to the pool. */
-        cl_qpool_put_list( &p_list->list_item_pool, &p_list->list );
+        cl_qpool_put_list( &p_list->list_item_pool, &p_list->list );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure from which to remove all objects.
+               [in] Pointer to a cl_list_t structure from which to remove all objects.
 

RETURN VALUE

       This function does not return a value.
 

SEE ALSO

-
       List, cl_list_remove_head, cl_list_remove_tail, cl_list_remove_object,
-       cl_list_remove_item
+
       List, cl_list_remove_head, cl_list_remove_tail, cl_list_remove_object,
+       cl_list_remove_item
 

-

[Functions] +

[Functions] Component Library: List/cl_list_remove_head

[top][index]

@@ -1088,29 +1088,29 @@ Component Library: List/cl_list_remove_head

SYNOPSIS

CL_INLINE void* CL_API
 cl_list_remove_head(
-        IN      cl_list_t* const        p_list )
+        IN      cl_list_t* const        p_list )
 {
         cl_pool_obj_t   *p_pool_obj;
 
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
         /* See if the list is empty. */
-        if( cl_is_qlist_empty( &p_list->list ) )
+        if( cl_is_qlist_empty( &p_list->list ) )
                 return( NULL );
 
         /* Get the item at the head of the list. */
-        p_pool_obj = (cl_pool_obj_t*)cl_qlist_remove_head( &p_list->list );
+        p_pool_obj = (cl_pool_obj_t*)cl_qlist_remove_head( &p_list->list );
 
         /* Place the pool item back into the pool. */
-        cl_qpool_put( &p_list->list_item_pool, (cl_pool_item_t*)p_pool_obj );
+        cl_qpool_put( &p_list->list_item_pool, (cl_pool_item_t*)p_pool_obj );
 
         return( (void*)p_pool_obj->list_obj.p_object );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure from which to remove an object.
+               [in] Pointer to a cl_list_t structure from which to remove an object.
 
  RETURN VALUES
        Returns the pointer to the object formerly at the head of the list.
@@ -1118,13 +1118,13 @@ Component Library: List/cl_list_remove_head
        NULL if the list was empty.
 

SEE ALSO

-
       List, cl_list_remove_tail, cl_list_remove_all, cl_list_remove_object,
-       cl_list_remove_item, cl_list_insert_head
+
       List, cl_list_remove_tail, cl_list_remove_all, cl_list_remove_object,
+       cl_list_remove_item, cl_list_insert_head
 

-

[Functions] +

[Functions] Component Library: List/cl_list_remove_item

[top][index]

@@ -1137,37 +1137,37 @@ Component Library: List/cl_list_remove_item

SYNOPSIS

CL_INLINE void CL_API
 cl_list_remove_item(
-        IN      cl_list_t* const                        p_list,
-        IN      const cl_list_iterator_t        iterator )
+        IN      cl_list_t* const                        p_list,
+        IN      const cl_list_iterator_t        iterator )
 {
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
-        cl_qlist_remove_item( &p_list->list, (cl_list_item_t*)iterator );
+        cl_qlist_remove_item( &p_list->list, (cl_list_item_t*)iterator );
 
         /* Place the list item back into the pool. */
-        cl_qpool_put( &p_list->list_item_pool, (cl_pool_item_t*)iterator );
+        cl_qpool_put( &p_list->list_item_pool, (cl_pool_item_t*)iterator );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure from which to remove the item.
+               [in] Pointer to a cl_list_t structure from which to remove the item.
 
        iterator
-               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
-               cl_list_tail, cl_list_next, or cl_list_prev.
+               [in] cl_list_iterator_t returned by a previous call to cl_list_head,
+               cl_list_tail, cl_list_next, or cl_list_prev.
 

RETURN VALUE

       This function does not return a value.
 

SEE ALSO

-
       List, cl_list_remove_object, cl_list_remove_head, cl_list_remove_tail,
-       cl_list_remove_all
+
       List, cl_list_remove_object, cl_list_remove_head, cl_list_remove_tail,
+       cl_list_remove_all
 

-

[Functions] +

[Functions] Component Library: List/cl_list_remove_object

[top][index]

@@ -1178,14 +1178,14 @@ Component Library: List/cl_list_remove_object

       The cl_list_remove_object function removes a specific object from a list.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_list_remove_object(
-        IN      cl_list_t* const        p_list,
+        IN      cl_list_t* const        p_list,
         IN      const void* const       p_object );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure from which to remove the object.
+               [in] Pointer to a cl_list_t structure from which to remove the object.
 
        p_object
                [in] Pointer to an object to remove from the list.
@@ -1199,13 +1199,13 @@ Component Library: List/cl_list_remove_object
 
       Removes the first occurrence of an object from a list.
 

SEE ALSO

-
       List, cl_list_remove_item, cl_list_remove_head, cl_list_remove_tail,
-       cl_list_remove_all
+
       List, cl_list_remove_item, cl_list_remove_head, cl_list_remove_tail,
+       cl_list_remove_all
 

-

[Functions] +

[Functions] Component Library: List/cl_list_remove_tail

[top][index]

@@ -1218,29 +1218,29 @@ Component Library: List/cl_list_remove_tail

SYNOPSIS

CL_INLINE void* CL_API
 cl_list_remove_tail(
-        IN      cl_list_t* const        p_list )
+        IN      cl_list_t* const        p_list )
 {
         cl_pool_obj_t   *p_pool_obj;
 
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
         /* See if the list is empty. */
-        if( cl_is_qlist_empty( &p_list->list ) )
+        if( cl_is_qlist_empty( &p_list->list ) )
                 return( NULL );
 
         /* Get the item at the head of the list. */
-        p_pool_obj = (cl_pool_obj_t*)cl_qlist_remove_tail( &p_list->list );
+        p_pool_obj = (cl_pool_obj_t*)cl_qlist_remove_tail( &p_list->list );
 
         /* Place the list item back into the pool. */
-        cl_qpool_put( &p_list->list_item_pool, (cl_pool_item_t*)p_pool_obj );
+        cl_qpool_put( &p_list->list_item_pool, (cl_pool_item_t*)p_pool_obj );
 
         return( (void*)p_pool_obj->list_obj.p_object );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure from which to remove an object.
+               [in] Pointer to a cl_list_t structure from which to remove an object.
 
  RETURN VALUES
        Returns the pointer to the object formerly at the tail of the list.
@@ -1248,13 +1248,13 @@ Component Library: List/cl_list_remove_tail
        NULL if the list was empty.
 

SEE ALSO

-
       List, cl_list_remove_head, cl_list_remove_all, cl_list_remove_object,
-       cl_list_remove_item, cl_list_insert_head
+
       List, cl_list_remove_head, cl_list_remove_all, cl_list_remove_object,
+       cl_list_remove_item, cl_list_insert_head
 

-

[Structures] +

[Structures] Component Library: List/cl_list_t

[top][index]

@@ -1262,7 +1262,7 @@ Component Library: List/cl_list_t

       cl_list_t
 

DESCRIPTION

-
       List structure.
+
       List structure.
 
        The cl_list_t structure should be treated as opaque and should be
        manipulated only through the provided functions.
@@ -1270,8 +1270,8 @@ Component Library: List/cl_list_t
 

SYNOPSIS

typedef struct _cl_list
 {
-        cl_qlist_t                      list;
-        cl_qpool_t                      list_item_pool;
+        cl_qlist_t                      list;
+        cl_qpool_t                      list_item_pool;
 
 } cl_list_t;
 
@@ -1283,12 +1283,12 @@ Component Library: List/cl_list_t Quick pool of list objects for storing objects in the quick list.

SEE ALSO

-
       List
+
       List
 

-

[Functions] +

[Functions] Component Library: List/cl_list_tail

[top][index]

@@ -1300,39 +1300,39 @@ Component Library: List/cl_list_tail

the tail of a list.

SYNOPSIS

-
CL_INLINE const cl_list_iterator_t CL_API
+
CL_INLINE const cl_list_iterator_t CL_API
 cl_list_tail(
-        IN      const cl_list_t* const  p_list )
+        IN      const cl_list_t* const  p_list )
 {
         CL_ASSERT( p_list );
-        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
+        CL_ASSERT( cl_is_qpool_inited( &p_list->list_item_pool ) );
 
-        return( cl_qlist_tail( &p_list->list ) );
+        return( cl_qlist_tail( &p_list->list ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_list_t structure for which the iterator for the
+               [in] Pointer to a cl_list_t structure for which the iterator for the
                object at the tail is to be returned.
 
  RETURN VALUES
-       cl_list_iterator_t for the tail of the list.
+       cl_list_iterator_t for the tail of the list.
 
-       cl_list_iterator_t for the end of the list if the list is empty.
+       cl_list_iterator_t for the end of the list if the list is empty.
 

NOTES

-
       Use cl_list_obj to retrieve the object associated with the
+
       Use cl_list_obj to retrieve the object associated with the
 
-       returned cl_list_iterator_t.
+       returned cl_list_iterator_t.
 

SEE ALSO

-
       List, cl_list_head, cl_list_next, cl_list_prev, cl_list_end,
-       cl_list_obj
+
       List, cl_list_head, cl_list_next, cl_list_prev, cl_list_end,
+       cl_list_obj
 

-

[Definitions] +

[Definitions] Component Library: List/cl_pfn_list_apply_t

[top][index]

@@ -1354,23 +1354,23 @@ Component Library: List/cl_pfn_list_apply_t

[in] Pointer to an object stored in a list. context - [in] Context provided in a call to cl_list_apply_func. + [in] Context provided in a call to cl_list_apply_func.

RETURN VALUE

       This function does not return a value.
 

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_list_apply_func
+       function provided by users as a parameter to the cl_list_apply_func
        function.
 

SEE ALSO

-
       List, cl_list_apply_func
+
       List, cl_list_apply_func
 

-

[Definitions] +

[Definitions] Component Library: List/cl_pfn_list_find_t

[top][index]

@@ -1382,7 +1382,7 @@ Component Library: List/cl_pfn_list_find_t

used to find objects in a list.

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_list_find_t)(
         IN      const void* const       p_object,
         IN      void*                           context );
@@ -1401,11 +1401,11 @@ Component Library: List/cl_pfn_list_find_t
 

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_list_find_from_head
-       and cl_list_find_from_tail functions.
+       function provided by users as a parameter to the cl_list_find_from_head
+       and cl_list_find_from_tail functions.
 

SEE ALSO

-
       List, cl_list_find_from_head, cl_list_find_from_tail
+
       List, cl_list_find_from_head, cl_list_find_from_tail
 
diff --git a/trunk/docs/complib/cl_log_h.html b/trunk/docs/complib/cl_log_h.html index 9827a552..754bf4d1 100644 --- a/trunk/docs/complib/cl_log_h.html +++ b/trunk/docs/complib/cl_log_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_log_h.html +./inc_docs/complib/cl_log_h.html -Generated from ./inc/complib/cl_log.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_log.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] +

[Modules] Component Library/Log Provider

-

[top][index]

+

[top][parent][index]

NAME

       Log Provider
 
@@ -25,7 +25,7 @@ Component Library/Log Provider


-

[Functions] +

[Functions] Component Library: Log Provider/cl_log_event

[top][index]

@@ -39,7 +39,7 @@ Component Library: Log Provider/cl_log_event

CL_EXPORT void CL_API
 cl_log_event(
         IN      const char* const       name,
-        IN      const cl_log_type_t     type,
+        IN      const cl_log_type_t     type,
         IN      const char* const       message,
         IN      const void* const       p_data OPTIONAL,
         IN      const uint32_t          data_len );
@@ -51,7 +51,7 @@ Component Library: Log Provider/cl_log_event
 
        type
                [in] Defines the type of log entry to add to the system log.
-               See the definition of cl_log_type_t for acceptable values.
+               See the definition of cl_log_type_t for acceptable values.
 
        message
                [in] Pointer to an ANSI string containing the text for the log entry.
@@ -74,12 +74,12 @@ Component Library: Log Provider/cl_log_event
        without its accompanying data.
 

SEE ALSO

-
       Log Provider, cl_log_type_t
+
       Log Provider, cl_log_type_t
 

-

[Definitions] +

[Definitions] Component Library: Log Provider/cl_log_type_t

[top][index]

@@ -110,7 +110,7 @@ Component Library: Log Provider/cl_log_type_t

Indicates a log entry is a fatal error.

SEE ALSO

-
       Log Provider, cl_log_event
+
       Log Provider, cl_log_event
 
diff --git a/trunk/docs/complib/cl_map_h.html b/trunk/docs/complib/cl_map_h.html index 3ad40166..2b83ba4c 100644 --- a/trunk/docs/complib/cl_map_h.html +++ b/trunk/docs/complib/cl_map_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_map_h.html +./inc_docs/complib/cl_map_h.html -Generated from ./inc/complib/cl_map.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_map.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] +

[Modules] Component Library/Map

-

[top][index]

+

[top][parent][index]

NAME

       Map
 
@@ -30,36 +30,36 @@ Component Library/Map

Map is not thread safe, and users must provide serialization when adding and removing items from the map. - The map functions operates on a cl_map_t structure which should be treated + The map functions operates on a cl_map_t structure which should be treated as opaque and should be manipulated only through the provided functions.

SEE ALSO

       Types:
-               cl_map_iterator_t
+               cl_map_iterator_t
 
        Structures:
-               cl_map_t, cl_map_item_t, cl_map_obj_t
+               cl_map_t, cl_map_item_t, cl_map_obj_t
 
        Item Manipulation:
-               cl_map_obj, cl_map_key
+               cl_map_obj, cl_map_key
 
        Initialization:
-               cl_map_construct, cl_map_init, cl_map_destroy
+               cl_map_construct, cl_map_init, cl_map_destroy
 
        Iteration:
-               cl_map_end, cl_map_head, cl_map_tail, cl_map_next, cl_map_prev
+               cl_map_end, cl_map_head, cl_map_tail, cl_map_next, cl_map_prev
 
        Manipulation
-               cl_map_insert, cl_map_get, cl_map_remove_item, cl_map_remove,
-               cl_map_remove_all, cl_map_merge, cl_map_delta
+               cl_map_insert, cl_map_get, cl_map_remove_item, cl_map_remove,
+               cl_map_remove_all, cl_map_merge, cl_map_delta
 
        Attributes:
-               cl_map_count, cl_is_map_empty, cl_is_map_inited
+               cl_map_count, cl_is_map_empty, cl_is_map_inited
 

-

[Functions] +

[Functions] Component Library: Event/cl_is_map_inited

[top][index]

@@ -73,18 +73,18 @@ Component Library: Event/cl_is_map_inited

SYNOPSIS

CL_INLINE boolean_t CL_API
 cl_is_map_inited(
-        IN      const cl_map_t* const   p_map )
+        IN      const cl_map_t* const   p_map )
 {
         /*
          * The map's pool of map items is the last thing initialized.
          * We can therefore use it to test for initialization.
          */
-        return( cl_is_qpool_inited( &p_map->pool ) );
+        return( cl_is_qpool_inited( &p_map->pool ) );
 }
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_map_t structure whose initialization state
+               [in] Pointer to a cl_map_t structure whose initialization state
                to check.
 
  RETURN VALUES
@@ -97,12 +97,12 @@ Component Library: Event/cl_is_map_inited
        member functions is appropriate.
 

SEE ALSO

-
       Map
+
       Map
 

-

[Functions] +

[Functions] Component Library: Map/cl_is_map_empty

[top][index]

@@ -115,10 +115,10 @@ Component Library: Map/cl_is_map_empty

SYNOPSIS

CL_INLINE boolean_t CL_API
 cl_is_map_empty(
-        IN      const cl_map_t* const   p_map )
+        IN      const cl_map_t* const   p_map )
 {
         CL_ASSERT( p_map );
-        return( cl_is_qmap_empty( &p_map->qmap ) );
+        return( cl_is_qmap_empty( &p_map->qmap ) );
 }
 

PARAMETERS

@@ -131,12 +131,12 @@ Component Library: Map/cl_is_map_empty FALSE otherwise.

SEE ALSO

-
       Map, cl_map_count, cl_map_remove_all
+
       Map, cl_map_count, cl_map_remove_all
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_construct

[top][index]

@@ -149,28 +149,28 @@ Component Library: Map/cl_map_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_map_construct(
-        IN      cl_map_t* const p_map );
+        IN      cl_map_t* const p_map );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_map_t structure to construct.
+               [in] Pointer to a cl_map_t structure to construct.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       Allows calling cl_map_init, cl_map_destroy, and cl_is_map_inited.
+
       Allows calling cl_map_init, cl_map_destroy, and cl_is_map_inited.
 
        Calling cl_map_construct is a prerequisite to calling any other
-       map function except cl_map_init.
+       map function except cl_map_init.
 

SEE ALSO

-
       Map, cl_map_init, cl_map_destroy, cl_is_map_inited
+
       Map, cl_map_init, cl_map_destroy, cl_is_map_inited
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_count

[top][index]

@@ -184,10 +184,10 @@ Component Library: Map/cl_map_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_map_count(
-        IN      const cl_map_t* const   p_map )
+        IN      const cl_map_t* const   p_map )
 {
         CL_ASSERT( p_map );
-        return( cl_qmap_count( &p_map->qmap ) );
+        return( cl_qmap_count( &p_map->qmap ) );
 }
 

PARAMETERS

@@ -198,12 +198,12 @@ Component Library: Map/cl_map_count
       Returns the number of items stored in the map.
 

SEE ALSO

-
       Map, cl_is_map_empty
+
       Map, cl_is_map_empty
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_delta

[top][index]

@@ -214,28 +214,28 @@ Component Library: Map/cl_map_delta

       The cl_map_delta function computes the differences between two maps.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_map_delta(
-        IN OUT  cl_map_t* const p_map1,
-        IN OUT  cl_map_t* const p_map2,
-        OUT             cl_map_t* const p_new,
-        OUT             cl_map_t* const p_old );
+        IN OUT  cl_map_t* const p_map1,
+        IN OUT  cl_map_t* const p_map2,
+        OUT             cl_map_t* const p_new,
+        OUT             cl_map_t* const p_old );
 

PARAMETERS

       p_map1
-               [in/out] Pointer to the first of two cl_map_t structures whose
+               [in/out] Pointer to the first of two cl_map_t structures whose
                differences to compute.
 
        p_map2
-               [in/out] Pointer to the second of two cl_map_t structures whose
+               [in/out] Pointer to the second of two cl_map_t structures whose
                differences to compute.
 
        p_new
-               [out] Pointer to an empty cl_map_t structure that contains the items
+               [out] Pointer to an empty cl_map_t structure that contains the items
                unique to p_map2 upon return from the function.
 
        p_old
-               [out] Pointer to an empty cl_map_t structure that contains the items
+               [out] Pointer to an empty cl_map_t structure that contains the items
                unique to p_map1 upon return from the function.
 
  RETURN VALUES
@@ -256,12 +256,12 @@ Component Library: Map/cl_map_delta
        Upon failure, all input maps are restored to their original state.
 

SEE ALSO

-
       Map, cl_map_merge
+
       Map, cl_map_merge
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_destroy

[top][index]

@@ -274,7 +274,7 @@ Component Library: Map/cl_map_destroy

SYNOPSIS

CL_EXPORT void CL_API
 cl_map_destroy(
-        IN      cl_map_t* const p_map );
+        IN      cl_map_t* const p_map );
 

PARAMETERS

       p_map
@@ -287,17 +287,17 @@ Component Library: Map/cl_map_destroy
 
       Performs any necessary cleanup of the specified map. Further
        operations should not be attempted on the map. cl_map_destroy does
        not affect any of the objects stored in the map.
-       This function should only be called after a call to cl_map_construct.
+       This function should only be called after a call to cl_map_construct.
 
        In debug builds, cl_map_destroy asserts that the map is empty.
 

SEE ALSO

-
       Map, cl_map_construct, cl_map_init
+
       Map, cl_map_construct, cl_map_init
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_end

[top][index]

@@ -308,36 +308,36 @@ Component Library: Map/cl_map_end

       The cl_map_end function returns the iterator for the end of a map.
 

SYNOPSIS

-
CL_INLINE const cl_map_iterator_t CL_API
+
CL_INLINE const cl_map_iterator_t CL_API
 cl_map_end(
-        IN      const cl_map_t* const   p_map )
+        IN      const cl_map_t* const   p_map )
 {
         CL_ASSERT( p_map );
-        return( cl_qmap_end( &p_map->qmap ) );
+        return( cl_qmap_end( &p_map->qmap ) );
 }
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_map_t structure whose end to return.
+               [in] Pointer to a cl_map_t structure whose end to return.
 

RETURN VALUE

       Iterator for the end of the map.
 

NOTES

       cl_map_end is useful for determining the validity of map items returned
-       by cl_map_head, cl_map_tail, cl_map_next, cl_map_prev.  If the iterator
+       by cl_map_head, cl_map_tail, cl_map_next, cl_map_prev.  If the iterator
        by any of these functions compares to the end, the end of the map was
        encoutered.
-       When using cl_map_head or cl_map_tail, this condition indicates that
+       When using cl_map_head or cl_map_tail, this condition indicates that
        the map is empty.
 

SEE ALSO

-
       Map, cl_qmap_head, cl_qmap_tail, cl_qmap_next, cl_qmap_prev
+
       Map, cl_qmap_head, cl_qmap_tail, cl_qmap_next, cl_qmap_prev
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_get

[top][index]

@@ -350,7 +350,7 @@ Component Library: Map/cl_map_get

SYNOPSIS

CL_EXPORT void* CL_API
 cl_map_get(
-        IN      const cl_map_t* const   p_map,
+        IN      const cl_map_t* const   p_map,
         IN      const uint64_t                  key );
 

PARAMETERS

@@ -371,12 +371,12 @@ Component Library: Map/cl_map_get
       cl_map_get does not remove the item from the map.
 

SEE ALSO

-
       Map, cl_map_remove
+
       Map, cl_map_remove
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_head

[top][index]

@@ -388,12 +388,12 @@ Component Library: Map/cl_map_head

value stored in a map.

SYNOPSIS

-
CL_INLINE cl_map_iterator_t CL_API
+
CL_INLINE cl_map_iterator_t CL_API
 cl_map_head(
-        IN      const cl_map_t* const   p_map )
+        IN      const cl_map_t* const   p_map )
 {
         CL_ASSERT( p_map );
-        return( cl_qmap_head( &p_map->qmap ) );
+        return( cl_qmap_head( &p_map->qmap ) );
 }
 

PARAMETERS

@@ -409,12 +409,12 @@ Component Library: Map/cl_map_head
       cl_map_head does not remove the object from the map.
 

SEE ALSO

-
       Map, cl_map_tail, cl_map_next, cl_map_prev, cl_map_end
+
       Map, cl_map_tail, cl_map_next, cl_map_prev, cl_map_end
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_init

[top][index]

@@ -425,14 +425,14 @@ Component Library: Map/cl_map_init

       The cl_map_init function initialized a map for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_map_init(
-        IN      cl_map_t* const p_map,
+        IN      cl_map_t* const p_map,
         IN      const size_t    min_items );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_map_t structure to initialize.
+               [in] Pointer to a cl_map_t structure to initialize.
 
        min_items
                [in] Minimum number of items that can be stored.  All necessary
@@ -446,12 +446,12 @@ Component Library: Map/cl_map_init
 
       Allows calling map manipulation functions.
 

SEE ALSO

-
       Map, cl_map_destroy, cl_map_insert, cl_map_remove
+
       Map, cl_map_destroy, cl_map_insert, cl_map_remove
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_insert

[top][index]

@@ -464,7 +464,7 @@ Component Library: Map/cl_map_insert

SYNOPSIS

CL_EXPORT void* CL_API
 cl_map_insert(
-        IN      cl_map_t* const         p_map,
+        IN      cl_map_t* const         p_map,
         IN      const uint64_t          key,
         IN      const void* const       p_object );
 
@@ -492,12 +492,12 @@ Component Library: Map/cl_map_insert returned.

SEE ALSO

-
       Map, cl_map_remove, cl_map_item_t
+
       Map, cl_map_remove, cl_map_item_t
 

-

[Definitions] +

[Definitions] Component Library: Map/cl_map_iterator_t

[top][index]

@@ -508,18 +508,18 @@ Component Library: Map/cl_map_iterator_t

       Iterator type used to walk a map.
 

SYNOPSIS

-
typedef const cl_map_item_t *cl_map_iterator_t;
+
typedef const cl_map_item_t *cl_map_iterator_t;
 

NOTES

       The iterator should be treated as opaque to prevent corrupting the map.
 

SEE ALSO

-
       Map, cl_map_head, cl_map_tail, cl_map_next, cl_map_prev, cl_map_key
+
       Map, cl_map_head, cl_map_tail, cl_map_next, cl_map_prev, cl_map_key
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_key

[top][index]

@@ -532,9 +532,9 @@ Component Library: Map/cl_map_key

SYNOPSIS

CL_INLINE uint64_t CL_API
 cl_map_key(
-        IN      const cl_map_iterator_t itor )
+        IN      const cl_map_iterator_t itor )
 {
-        return( cl_qmap_key( itor ) );
+        return( cl_qmap_key( itor ) );
 }
 

PARAMETERS

@@ -546,17 +546,17 @@ Component Library: Map/cl_map_key

NOTES

       The iterator specified by the itor parameter must have been retrived by
-       a previous call to cl_map_head, cl_map_tail, cl_map_next, or cl_map_prev.
+       a previous call to cl_map_head, cl_map_tail, cl_map_next, or cl_map_prev.
 
-       The key value is set in a call to cl_map_insert.
+       The key value is set in a call to cl_map_insert.
 

SEE ALSO

-
       Map, cl_map_insert, cl_map_head, cl_map_tail, cl_map_next, cl_map_prev
+
       Map, cl_map_insert, cl_map_head, cl_map_tail, cl_map_next, cl_map_prev
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_merge

[top][index]

@@ -568,17 +568,17 @@ Component Library: Map/cl_map_merge

excluding duplicates.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_map_merge(
-        OUT             cl_map_t* const p_dest_map,
-        IN OUT  cl_map_t* const p_src_map );
+        OUT             cl_map_t* const p_dest_map,
+        IN OUT  cl_map_t* const p_src_map );
 

PARAMETERS

       p_dest_map
-               [out] Pointer to a cl_map_t structure to which items should be added.
+               [out] Pointer to a cl_map_t structure to which items should be added.
 
        p_src_map
-               [in/out] Pointer to a cl_map_t structure whose items to add
+               [in/out] Pointer to a cl_map_t structure whose items to add
                to p_dest_map.
 
  RETURN VALUES
@@ -594,12 +594,12 @@ Component Library: Map/cl_map_merge
        all duplicate items.
 

SEE ALSO

-
       Map, cl_map_delta
+
       Map, cl_map_delta
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_next

[top][index]

@@ -611,12 +611,12 @@ Component Library: Map/cl_map_next

key value than a specified map item.

SYNOPSIS

-
CL_INLINE cl_map_iterator_t CL_API
+
CL_INLINE cl_map_iterator_t CL_API
 cl_map_next(
-        IN      const cl_map_iterator_t itor )
+        IN      const cl_map_iterator_t itor )
 {
         CL_ASSERT( itor );
-        return( cl_qmap_next( itor ) );
+        return( cl_qmap_next( itor ) );
 }
 

PARAMETERS

@@ -630,16 +630,16 @@ Component Library: Map/cl_map_next the map.

NOTES

-
       The iterator must have been retrieved by a previous call to cl_map_head,
-       cl_map_tail, cl_map_next, or cl_map_prev.
+
       The iterator must have been retrieved by a previous call to cl_map_head,
+       cl_map_tail, cl_map_next, or cl_map_prev.
 

SEE ALSO

-
       Map, cl_map_head, cl_map_tail, cl_map_prev, cl_map_end
+
       Map, cl_map_head, cl_map_tail, cl_map_prev, cl_map_end
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_obj

[top][index]

@@ -652,9 +652,9 @@ Component Library: Map/cl_map_obj

SYNOPSIS

CL_INLINE void* CL_API
 cl_map_obj(
-        IN      const cl_map_iterator_t itor )
+        IN      const cl_map_iterator_t itor )
 {
-        return( cl_qmap_obj( PARENT_STRUCT( itor, cl_map_obj_t, item ) ) );
+        return( cl_qmap_obj( PARENT_STRUCT( itor, cl_map_obj_t, item ) ) );
 }
 

PARAMETERS

@@ -664,16 +664,16 @@ Component Library: Map/cl_map_obj RETURN VALUES Returns the value of the object pointer associated with the iterator. - The iterator must have been retrieved by a previous call to cl_map_head, - cl_map_tail, cl_map_next, or cl_map_prev. + The iterator must have been retrieved by a previous call to cl_map_head, + cl_map_tail, cl_map_next, or cl_map_prev.

SEE ALSO

-
       Map, cl_map_head, cl_map_tail, cl_map_next, cl_map_prev
+
       Map, cl_map_head, cl_map_tail, cl_map_next, cl_map_prev
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_prev

[top][index]

@@ -685,12 +685,12 @@ Component Library: Map/cl_map_prev

key value than a precified map item.

SYNOPSIS

-
CL_INLINE cl_map_iterator_t CL_API
+
CL_INLINE cl_map_iterator_t CL_API
 cl_map_prev(
-        IN      const cl_map_iterator_t itor )
+        IN      const cl_map_iterator_t itor )
 {
         CL_ASSERT( itor );
-        return( cl_qmap_prev( itor ) );
+        return( cl_qmap_prev( itor ) );
 }
 

PARAMETERS

@@ -704,16 +704,16 @@ Component Library: Map/cl_map_prev the map.

NOTES

-
       The iterator must have been retrieved by a previous call to cl_map_head,
-       cl_map_tail, cl_map_next, or cl_map_prev.
+
       The iterator must have been retrieved by a previous call to cl_map_head,
+       cl_map_tail, cl_map_next, or cl_map_prev.
 

SEE ALSO

-
       Map, cl_map_head, cl_map_tail, cl_map_next, cl_map_end
+
       Map, cl_map_head, cl_map_tail, cl_map_next, cl_map_end
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_remove

[top][index]

@@ -727,12 +727,12 @@ Component Library: Map/cl_map_remove

SYNOPSIS

CL_EXPORT void* CL_API
 cl_map_remove(
-        IN      cl_map_t* const p_map,
+        IN      cl_map_t* const p_map,
         IN      const uint64_t  key );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_map_t structure from which to remove the item
+               [in] Pointer to a cl_map_t structure from which to remove the item
                with the specified key.
 
        key
@@ -745,12 +745,12 @@ Component Library: Map/cl_map_remove
        NULL if no object with the specified key exists in the map.
 

SEE ALSO

-
       Map, cl_map_remove_item, cl_map_remove_all, cl_map_insert
+
       Map, cl_map_remove_item, cl_map_remove_all, cl_map_insert
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_remove_all

[top][index]

@@ -764,7 +764,7 @@ Component Library: Map/cl_map_remove_all

SYNOPSIS

CL_EXPORT void CL_API
 cl_map_remove_all(
-        IN      cl_map_t* const p_map );
+        IN      cl_map_t* const p_map );
 

PARAMETERS

       p_map
@@ -774,12 +774,12 @@ Component Library: Map/cl_map_remove_all
 
       This function does not return a value.
 

SEE ALSO

-
       Map, cl_map_remove, cl_map_remove_item
+
       Map, cl_map_remove, cl_map_remove_item
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_remove_item

[top][index]

@@ -793,8 +793,8 @@ Component Library: Map/cl_map_remove_item

SYNOPSIS

CL_EXPORT void CL_API
 cl_map_remove_item(
-        IN      cl_map_t* const                 p_map,
-        IN      const cl_map_iterator_t itor );
+        IN      cl_map_t* const                 p_map,
+        IN      const cl_map_iterator_t itor );
 

PARAMETERS

       p_map
@@ -812,17 +812,17 @@ Component Library: Map/cl_map_remove_item
 
        The specified iterator is no longer valid after the call completes.
 
-       The iterator must have been retrieved by a previous call to cl_map_head,
-       cl_map_tail, cl_map_next, or cl_map_prev.
+       The iterator must have been retrieved by a previous call to cl_map_head,
+       cl_map_tail, cl_map_next, or cl_map_prev.
 

SEE ALSO

-
       Map, cl_map_remove, cl_map_remove_all, cl_map_insert, cl_map_head,
-       cl_map_tail, cl_map_next, cl_map_prev
+
       Map, cl_map_remove, cl_map_remove_all, cl_map_insert, cl_map_head,
+       cl_map_tail, cl_map_next, cl_map_prev
 

-

[Structures] +

[Structures] Component Library: Map/cl_map_t

[top][index]

@@ -838,8 +838,8 @@ Component Library: Map/cl_map_t

SYNOPSIS

typedef struct _cl_map
 {
-        cl_qmap_t       qmap;
-        cl_qpool_t      pool;
+        cl_qmap_t       qmap;
+        cl_qpool_t      pool;
 
 } cl_map_t;
 
@@ -848,16 +848,16 @@ Component Library: Map/cl_map_t Quick map object that maintains the map. pool - Pool of cl_map_obj_t structures used to store user objects + Pool of cl_map_obj_t structures used to store user objects in the map.

SEE ALSO

-
       Map, cl_map_obj_t
+
       Map, cl_map_obj_t
 

-

[Functions] +

[Functions] Component Library: Map/cl_map_tail

[top][index]

@@ -869,12 +869,12 @@ Component Library: Map/cl_map_tail

value stored in a map.

SYNOPSIS

-
CL_INLINE cl_map_iterator_t CL_API
+
CL_INLINE cl_map_iterator_t CL_API
 cl_map_tail(
-        IN      const cl_map_t* const   p_map )
+        IN      const cl_map_t* const   p_map )
 {
         CL_ASSERT( p_map );
-        return( cl_qmap_tail( &p_map->qmap ) );
+        return( cl_qmap_tail( &p_map->qmap ) );
 }
 

PARAMETERS

@@ -888,10 +888,10 @@ Component Library: Map/cl_map_tail Iterator for the map end if the map was empty.

NOTES

-
       cl_map_end does no remove the object from the map.
+
       cl_map_end does no remove the object from the map.
 

SEE ALSO

-
       Map, cl_map_head, cl_map_next, cl_map_prev, cl_map_end
+
       Map, cl_map_head, cl_map_next, cl_map_prev, cl_map_end
 
diff --git a/trunk/docs/complib/cl_math_h.html b/trunk/docs/complib/cl_math_h.html index cbc4e8dc..a5639b9e 100644 --- a/trunk/docs/complib/cl_math_h.html +++ b/trunk/docs/complib/cl_math_h.html @@ -2,16 +2,16 @@ -./inc_doc/complib/cl_math_h.html +./inc_docs/complib/cl_math_h.html -Generated from ./inc/complib/cl_math.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_math.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Definitions] +

[Definitions] Component Library: Math/MAX

[top][index]

@@ -35,12 +35,12 @@ Component Library: Math/MAX

       Returns the greater of the x and y parameters.
 

SEE ALSO

-
       MIN, ROUNDUP
+
       MIN, ROUNDUP
 

-

[Definitions] +

[Definitions] Component Library: Math/MIN

[top][index]

@@ -64,12 +64,12 @@ Component Library: Math/MIN

       Returns the lesser of the x and y parameters.
 

SEE ALSO

-
       MAX, ROUNDUP
+
       MAX, ROUNDUP
 

-

[Definitions] +

[Definitions] Component Library: Math/ROUNDUP

[top][index]

diff --git a/trunk/docs/complib/cl_memory_h.html b/trunk/docs/complib/cl_memory_h.html index 2b36ba67..21ffb5ae 100644 --- a/trunk/docs/complib/cl_memory_h.html +++ b/trunk/docs/complib/cl_memory_h.html @@ -2,12 +2,12 @@ -./inc_doc/complib/cl_memory_h.html +./inc_docs/complib/cl_memory_h.html -Generated from ./inc/complib/cl_memory.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_memory.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

@@ -38,7 +38,7 @@ Public/Memory Management


-

[Functions] +

[Functions] Component Library: Memory Management/cl_check_for_read

[top][index]

@@ -49,7 +49,7 @@ Component Library: Memory Management/cl_check_for_read

       Checks a user-mode virtual address for read access.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_check_for_read(
         IN      const void* const       vaddr,
         IN      const size_t            count );
@@ -74,12 +74,12 @@ Component Library: Memory Management/cl_check_for_read
        request).  Callers cannot be holding a spinlock when calling this function.
 

SEE ALSO

-
       Memory Management, cl_check_for_write, cl_copy_to_user, cl_copy_from_user
+
       Memory Management, cl_check_for_write, cl_copy_to_user, cl_copy_from_user
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_check_for_write

[top][index]

@@ -90,7 +90,7 @@ Component Library: Memory Management/cl_check_for_write

       Checks a user-mode virtual address for write access.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_check_for_write(
         IN      void* const             vaddr,
         IN      const size_t    count );
@@ -115,12 +115,12 @@ Component Library: Memory Management/cl_check_for_write
        request).  Callers cannot be holding a spinlock when calling this function.
 

SEE ALSO

-
       Memory Management, cl_check_for_read, cl_copy_to_user, cl_copy_from_user
+
       Memory Management, cl_check_for_read, cl_copy_to_user, cl_copy_from_user
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_copy_from_user

[top][index]

@@ -131,7 +131,7 @@ Component Library: Memory Management/cl_copy_from_user

       Copies data from a user-mode buffer, performing access checks.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_copy_from_user(
         IN      void* const                     p_dest,
         IN      const void* const       p_src,
@@ -160,12 +160,12 @@ Component Library: Memory Management/cl_copy_from_user
        request).  Callers cannot be holding a spinlock when calling this function.
 

SEE ALSO

-
       Memory Management, cl_check_for_read, cl_check_for_write, cl_copy_to_user
+
       Memory Management, cl_check_for_read, cl_check_for_write, cl_copy_to_user
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_copy_to_user

[top][index]

@@ -176,7 +176,7 @@ Component Library: Memory Management/cl_copy_to_user

       Copies data into a user-mode buffer, performing access checks.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_copy_to_user(
         IN      void* const                     p_dest,
         IN      const void* const       p_src,
@@ -205,12 +205,12 @@ Component Library: Memory Management/cl_copy_to_user
        request).  Callers cannot be holding a spinlock when calling this function.
 

SEE ALSO

-
       Memory Management, cl_check_for_read, cl_check_for_write, cl_copy_from_user
+
       Memory Management, cl_check_for_read, cl_check_for_write, cl_copy_from_user
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_free

[top][index]

@@ -234,17 +234,17 @@ Component Library: Memory Management/cl_free

NOTES

       The p_memory parameter is the pointer returned by a previous call to
-       cl_malloc, or cl_zalloc.
+       cl_malloc, or cl_zalloc.
 
        cl_free has no effect if p_memory is NULL.
 

SEE ALSO

-
       Memory Management, cl_alloc, cl_zalloc
+
       Memory Management, cl_alloc, cl_zalloc
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_get_pagesize

[top][index]

@@ -271,7 +271,7 @@ Component Library: Memory Management/cl_get_pagesize


-

[Functions] +

[Functions] Component Library: Memory Management/cl_get_physaddr

[top][index]

@@ -302,7 +302,7 @@ Component Library: Memory Management/cl_get_physaddr


-

[Functions] +

[Functions] Component Library: Memory Management/cl_malloc

[top][index]

@@ -331,13 +331,13 @@ Component Library: Memory Management/cl_malloc

environments.

SEE ALSO

-
       Memory Management, cl_free, cl_zalloc, cl_palloc, cl_pzalloc,
-       cl_memset, cl_memclr, cl_memcpy, cl_memcmp
+
       Memory Management, cl_free, cl_zalloc, cl_palloc, cl_pzalloc,
+       cl_memset, cl_memclr, cl_memcpy, cl_memcmp
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_mem_display

[top][index]

@@ -368,7 +368,7 @@ Component Library: Memory Management/cl_mem_display


-

[Functions] +

[Functions] Component Library: Memory Management/cl_memclr

[top][index]

@@ -384,7 +384,7 @@ Component Library: Memory Management/cl_memclr

IN void* const p_memory, IN const size_t count ) { - cl_memset( p_memory, 0, count ); + cl_memset( p_memory, 0, count ); }

PARAMETERS

@@ -398,12 +398,12 @@ Component Library: Memory Management/cl_memclr
       This function does not return a value.
 

SEE ALSO

-
       Memory Management, cl_memset, cl_memcpy, cl_memcmp
+
       Memory Management, cl_memset, cl_memcpy, cl_memcmp
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_memcmp

[top][index]

@@ -438,12 +438,12 @@ Component Library: Memory Management/cl_memcmp

Returns zero if the two memory regions are the identical.

SEE ALSO

-
       Memory Management, cl_memset, cl_memclr, cl_memcpy
+
       Memory Management, cl_memset, cl_memclr, cl_memcpy
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_memcpy

[top][index]

@@ -476,12 +476,12 @@ Component Library: Memory Management/cl_memcpy

       Returns a pointer to the destination buffer.
 

SEE ALSO

-
       Memory Management, cl_memset, cl_memclr, cl_memcmp
+
       Memory Management, cl_memset, cl_memclr, cl_memcmp
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_memset

[top][index]

@@ -512,12 +512,12 @@ Component Library: Memory Management/cl_memset

       This function does not return a value.
 

SEE ALSO

-
       Memory Management, cl_memclr, cl_memcpy, cl_memcmp
+
       Memory Management, cl_memclr, cl_memcpy, cl_memcmp
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_palloc

[top][index]

@@ -527,7 +527,7 @@ Component Library: Memory Management/cl_palloc

DESCRIPTION

       The cl_palloc function allocates a block of memory from paged pool if the
        operating system supports it.  If the operating system does not distinguish
-       between pool types, cl_palloc is identical to cl_malloc.
+       between pool types, cl_palloc is identical to cl_malloc.
 

SYNOPSIS

void*
@@ -548,13 +548,13 @@ Component Library: Memory Management/cl_palloc
        environments.
 

SEE ALSO

-
       Memory Management, cl_free, cl_malloc, cl_zalloc, cl_pzalloc,
-       cl_memset, cl_memclr, cl_memcpy, cl_memcmp
+
       Memory Management, cl_free, cl_malloc, cl_zalloc, cl_pzalloc,
+       cl_memset, cl_memclr, cl_memcpy, cl_memcmp
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_pzalloc

[top][index]

@@ -565,7 +565,7 @@ Component Library: Memory Management/cl_pzalloc

       The cl_pzalloc function allocates a block of memory from paged pool if the
        operating system supports it and initializes it to zero.  If the operating
        system does not distinguish between pool types, cl_pzalloc is identical
-       to cl_zalloc.
+       to cl_zalloc.
 

SYNOPSIS

void*
@@ -586,13 +586,13 @@ Component Library: Memory Management/cl_pzalloc
        environments.
 

SEE ALSO

-
       Memory Management, cl_free, cl_malloc, cl_zalloc, cl_palloc,
-       cl_memset, cl_memclr, cl_memcpy, cl_memcmp
+
       Memory Management, cl_free, cl_malloc, cl_zalloc, cl_palloc,
+       cl_memset, cl_memclr, cl_memcpy, cl_memcmp
 

-

[Functions] +

[Functions] Component Library: Memory Management/cl_zalloc

[top][index]

@@ -621,8 +621,8 @@ Component Library: Memory Management/cl_zalloc

environments.

SEE ALSO

-
       Memory Management, cl_free, cl_malloc, cl_palloc, cl_pzalloc,
-       cl_memset, cl_memclr, cl_memcpy, cl_memcmp
+
       Memory Management, cl_free, cl_malloc, cl_palloc, cl_pzalloc,
+       cl_memset, cl_memclr, cl_memcpy, cl_memcmp
 
diff --git a/trunk/docs/complib/cl_mutex_h.html b/trunk/docs/complib/cl_mutex_h.html index 636dca7e..7ba0a71f 100644 --- a/trunk/docs/complib/cl_mutex_h.html +++ b/trunk/docs/complib/cl_mutex_h.html @@ -2,12 +2,12 @@ -./inc_doc/complib/cl_mutex_h.html +./inc_docs/complib/cl_mutex_h.html -Generated from ./inc/complib/cl_mutex.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_mutex.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

@@ -31,15 +31,15 @@ complib/Mutex cl_mutex_t Initialization: - cl_mutex_construct, cl_mutex_init, cl_mutex_destroy + cl_mutex_construct, cl_mutex_init, cl_mutex_destroy Manipulation - cl_mutex_acquire, cl_mutex_release + cl_mutex_acquire, cl_mutex_release

-

[Functions] +

[Functions] Component Library: Mutex/cl_mutex_acquire

[top][index]

@@ -62,12 +62,12 @@ Component Library: Mutex/cl_mutex_acquire

       This function does not return a value.
 

SEE ALSO

-
       Mutex, cl_mutex_release
+
       Mutex, cl_mutex_release
 

-

[Functions] +

[Functions] Component Library: Mutex/cl_mutex_construct

[top][index]

@@ -92,18 +92,18 @@ Component Library: Mutex/cl_mutex_construct

NOTES

       Allows calling cl_semphore_destroy without first calling
-       cl_mutex_init.
+       cl_mutex_init.
 
        Calling cl_mutex_construct is a prerequisite to calling any other
-       mutex function except cl_mutex_init.
+       mutex function except cl_mutex_init.
 

SEE ALSO

-
       Mutex, cl_semphore_init cl_mutex_destroy
+
       Mutex, cl_semphore_init cl_mutex_destroy
 

-

[Functions] +

[Functions] Component Library: Mutex/cl_mutex_destroy

[top][index]

@@ -128,16 +128,16 @@ Component Library: Mutex/cl_mutex_destroy

NOTES

       Performs any necessary cleanup of a mutex. This function must only
-       be called if either cl_mutex_construct or cl_mutex_init has been
+       be called if either cl_mutex_construct or cl_mutex_init has been
        called.
 

SEE ALSO

-
       Mutex, cl_mutex_construct, cl_mutex_init
+
       Mutex, cl_mutex_construct, cl_mutex_init
 

-

[Functions] +

[Functions] Component Library: Mutex/cl_mutex_init

[top][index]

@@ -148,7 +148,7 @@ Component Library: Mutex/cl_mutex_init

       The cl_mutex_init function initializes a mutex for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_mutex_init(
         IN      cl_mutex_t* const       p_mutex );
 
@@ -160,21 +160,21 @@ Component Library: Mutex/cl_mutex_init CL_SUCCESS if initialization succeeded. CL_ERROR if initialization failed. Callers should call - cl_mutex_destroy to clean up any resources allocated during + cl_mutex_destroy to clean up any resources allocated during initialization.

NOTES

       Initializes the mutex structure. Allows calling cl_mutex_aquire
-       and cl_mutex_release. The cl_mutex is always created in the unlocked state.
+       and cl_mutex_release. The cl_mutex is always created in the unlocked state.
 

SEE ALSO

-
       Mutex, cl_mutex_construct, cl_mutex_destroy,
-       cl_mutex_acquire, cl_mutex_release
+
       Mutex, cl_mutex_construct, cl_mutex_destroy,
+       cl_mutex_acquire, cl_mutex_release
 

-

[Functions] +

[Functions] Component Library: Mutex/cl_mutex_release

[top][index]

@@ -197,10 +197,10 @@ Component Library: Mutex/cl_mutex_release

       This function does not return a value.
 

NOTES

-
       Releases a mutex after a call to cl_mutex_acquire.
+
       Releases a mutex after a call to cl_mutex_acquire.
 

SEE ALSO

-
       Mutex, cl_mutex_acquire
+
       Mutex, cl_mutex_acquire
 
diff --git a/trunk/docs/complib/cl_obj_h.html b/trunk/docs/complib/cl_obj_h.html index 5c729d45..d52c5444 100644 --- a/trunk/docs/complib/cl_obj_h.html +++ b/trunk/docs/complib/cl_obj_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_obj_h.html +./inc_docs/complib/cl_obj_h.html -Generated from ./inc/complib/cl_obj.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_obj.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] +

[Modules] Component Library/Object

-

[top][index]

+

[top][parent][index]

NAME

       Object
 
@@ -39,29 +39,29 @@ Component Library/Object

SEE ALSO

       Types
-               cl_destroy_type_t
+               cl_destroy_type_t
 
        Structures:
-               cl_obj_t, cl_obj_rel_t
+               cl_obj_t, cl_obj_rel_t
 
        Callbacks:
-               cl_pfn_obj_call_t
+               cl_pfn_obj_call_t
 
        Initialization/Destruction:
-               cl_obj_mgr_create, cl_obj_mgr_destroy,
-               cl_obj_construct, cl_obj_init, cl_obj_destroy, cl_obj_deinit
+               cl_obj_mgr_create, cl_obj_mgr_destroy,
+               cl_obj_construct, cl_obj_init, cl_obj_destroy, cl_obj_deinit
 
        Object Relationships:
-               cl_obj_ref, cl_obj_deref,
-               cl_rel_alloc, cl_rel_free, cl_obj_insert_rel, cl_obj_remove_rel
+               cl_obj_ref, cl_obj_deref,
+               cl_rel_alloc, cl_rel_free, cl_obj_insert_rel, cl_obj_remove_rel
 
        Object Manipulation:
-               cl_obj_reset
+               cl_obj_reset
 

-

[Definitions] +

[Definitions] Component Library: Object/cl_destroy_type_t

[top][index]

@@ -94,12 +94,12 @@ Component Library: Object/cl_destroy_type_t

processing is completed by the calling thread.

SEE ALSO

-
       Object, cl_obj_init, cl_obj_destroy, cl_obj_deinit, cl_obj_t
+
       Object, cl_obj_init, cl_obj_destroy, cl_obj_deinit, cl_obj_t
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_construct

[top][index]

@@ -113,7 +113,7 @@ Component Library: Object/cl_obj_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_obj_construct(
-        IN                              cl_obj_t * const                        p_obj,
+        IN                              cl_obj_t * const                        p_obj,
         IN              const   uint32_t                                        obj_type );
 

PARAMETERS

@@ -132,12 +132,12 @@ Component Library: Object/cl_obj_construct
       This call must succeed before invoking any other function on an object.
 

SEE ALSO

-
       Object, cl_obj_init, cl_obj_destroy, cl_obj_deinit.
+
       Object, cl_obj_init, cl_obj_destroy, cl_obj_deinit.
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_deinit

[top][index]

@@ -151,7 +151,7 @@ Component Library: Object/cl_obj_deinit

SYNOPSIS

CL_EXPORT void CL_API
 cl_obj_deinit(
-        IN                              cl_obj_t * const                        p_obj );
+        IN                              cl_obj_t * const                        p_obj );
 

PARAMETERS

       p_obj
@@ -165,12 +165,12 @@ Component Library: Object/cl_obj_deinit
        manager.
 

SEE ALSO

-
       Object, cl_obj_construct, cl_obj_init, cl_obj_destroy, cl_obj_t
+
       Object, cl_obj_construct, cl_obj_init, cl_obj_destroy, cl_obj_t
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_deref

[top][index]

@@ -184,7 +184,7 @@ Component Library: Object/cl_obj_deref

SYNOPSIS

CL_EXPORT int32_t CL_API
 cl_obj_deref(
-        IN                              cl_obj_t * const                        p_obj );
+        IN                              cl_obj_t * const                        p_obj );
 

PARAMETERS

       p_obj
@@ -194,12 +194,12 @@ Component Library: Object/cl_obj_deref
 
       The updated reference count.
 

SEE ALSO

-
       Object, cl_obj_t, cl_obj_ref
+
       Object, cl_obj_t, cl_obj_ref
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_destroy

[top][index]

@@ -212,7 +212,7 @@ Component Library: Object/cl_obj_destroy

SYNOPSIS

CL_EXPORT void CL_API
 cl_obj_destroy(
-        IN                              cl_obj_t *                                      p_obj );
+        IN                              cl_obj_t *                                      p_obj );
 

PARAMETERS

       p_obj
@@ -224,20 +224,20 @@ Component Library: Object/cl_obj_destroy
 

NOTES

       This routine starts the destruction process for the specified object.  For
        additional information regarding destruction callbacks, see the following
-       fields in cl_obj_t and parameters in cl_obj_init: pfn_destroying,
+       fields in cl_obj_t and parameters in cl_obj_init: pfn_destroying,
        pfn_cleanup, and pfn_free.
 
-       In most cases, after calling this routine, users should call cl_obj_deinit
+       In most cases, after calling this routine, users should call cl_obj_deinit
        from within their pfn_free callback routine.
 

SEE ALSO

-
       Object, cl_obj_construct, cl_obj_init, cl_obj_deinit,
-       cl_obj_t, cl_destroy_type_t, cl_pfn_obj_call_t
+
       Object, cl_obj_construct, cl_obj_init, cl_obj_deinit,
+       cl_obj_t, cl_destroy_type_t, cl_pfn_obj_call_t
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_init

[top][index]

@@ -249,13 +249,13 @@ Component Library: Object/cl_obj_init

of this call, the object is ready for use.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_obj_init(
-        IN                              cl_obj_t * const                        p_obj,
-        IN                              cl_destroy_type_t                       destroy_type,
-        IN              const   cl_pfn_obj_call_t                       pfn_destroying OPTIONAL,
-        IN              const   cl_pfn_obj_call_t                       pfn_cleanup OPTIONAL,
-        IN              const   cl_pfn_obj_call_t                       pfn_free );
+        IN                              cl_obj_t * const                        p_obj,
+        IN                              cl_destroy_type_t                       destroy_type,
+        IN              const   cl_pfn_obj_call_t                       pfn_destroying OPTIONAL,
+        IN              const   cl_pfn_obj_call_t                       pfn_cleanup OPTIONAL,
+        IN              const   cl_pfn_obj_call_t                       pfn_free );
 

PARAMETERS

       p_obj
@@ -280,7 +280,7 @@ Component Library: Object/cl_obj_init
        pfn_free
                [in] User-specified callback invoked to notify a user that an object has
                been destroyed and is ready for deallocation.  Users should either
-               call cl_obj_deinit or cl_obj_reset from within this callback.
+               call cl_obj_deinit or cl_obj_reset from within this callback.
 

RETURN VALUE

       CL_SUCCESS
@@ -305,18 +305,18 @@ Component Library: Object/cl_obj_init
 
        Pfn_free is called to notify the user that the destruction of the object has
        completed.  All relationships have been removed, and all child objects have
-       been destroyed.  Relationship items (cl_obj_rel_t) that were used to
+       been destroyed.  Relationship items (cl_obj_rel_t) that were used to
        identify parent objects are returned to the user through the p_parent_list
-       field of the cl_obj_t structure.
+       field of the cl_obj_t structure.
 

SEE ALSO

-
       Object, cl_obj_construct, cl_obj_destroy, cl_obj_deinit,
-       cl_obj_t, cl_destroy_type_t, cl_pfn_obj_call_t,
+
       Object, cl_obj_construct, cl_obj_destroy, cl_obj_deinit,
+       cl_obj_t, cl_destroy_type_t, cl_pfn_obj_call_t,
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_insert_rel

[top][index]

@@ -328,11 +328,11 @@ Component Library: Object/cl_obj_insert_rel

object dependent on the parent.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_obj_insert_rel(
-        IN                              cl_obj_rel_t * const            p_rel,
-        IN                              cl_obj_t * const                        p_parent_obj,
-        IN                              cl_obj_t * const                        p_child_obj );
+        IN                              cl_obj_rel_t * const            p_rel,
+        IN                              cl_obj_t * const                        p_parent_obj,
+        IN                              cl_obj_t * const                        p_child_obj );
 

PARAMETERS

       p_rel
@@ -358,12 +358,12 @@ Component Library: Object/cl_obj_insert_rel
        object cannot be both the parent and a child of a second object.)
 

SEE ALSO

-
       Object, cl_rel_alloc, cl_rel_free, cl_obj_remove_rel, cl_obj_destroy
+
       Object, cl_rel_alloc, cl_rel_free, cl_obj_remove_rel, cl_obj_destroy
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_insert_rel_parent_locked

[top][index]

@@ -375,11 +375,11 @@ Component Library: Object/cl_obj_insert_rel_parent_locked

object dependent on the parent. The parent's object lock is held.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_obj_insert_rel_parent_locked(
-        IN                              cl_obj_rel_t * const            p_rel,
-        IN                              cl_obj_t * const                        p_parent_obj,
-        IN                              cl_obj_t * const                        p_child_obj );
+        IN                              cl_obj_rel_t * const            p_rel,
+        IN                              cl_obj_t * const                        p_parent_obj,
+        IN                              cl_obj_t * const                        p_child_obj );
 

PARAMETERS

       p_rel
@@ -407,12 +407,12 @@ Component Library: Object/cl_obj_insert_rel_parent_locked
        This call requires the caller to already hold the parent object's lock.
 

SEE ALSO

-
       Object, cl_rel_alloc, cl_rel_free, cl_obj_remove_rel, cl_obj_destroy
+
       Object, cl_rel_alloc, cl_rel_free, cl_obj_remove_rel, cl_obj_destroy
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_lock

[top][index]

@@ -425,11 +425,11 @@ Component Library: Object/cl_obj_lock

SYNOPSIS

CL_INLINE void CL_API
 cl_obj_lock(
-        IN                              cl_obj_t * const                        p_obj )
+        IN                              cl_obj_t * const                        p_obj )
 {
         CL_ASSERT( p_obj->state == CL_INITIALIZED ||
                 p_obj->state == CL_DESTROYING );
-        cl_spinlock_acquire( &p_obj->lock );
+        cl_spinlock_acquire( &p_obj->lock );
 }
 

PARAMETERS

@@ -440,12 +440,12 @@ Component Library: Object/cl_obj_lock
       This function does not return a value.
 

SEE ALSO

-
       Object, cl_obj_t, cl_obj_unlock
+
       Object, cl_obj_t, cl_obj_unlock
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_mgr_create

[top][index]

@@ -458,7 +458,7 @@ Component Library: Object/cl_obj_mgr_create

objects that are not destroyed properly.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_obj_mgr_create(void);
 

PARAMETERS

@@ -475,12 +475,12 @@ Component Library: Object/cl_obj_mgr_create
       This call must succeed before invoking any other object-related function.
 

SEE ALSO

-
       Object, cl_obj_mgr_destroy
+
       Object, cl_obj_mgr_destroy
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_mgr_destroy

[top][index]

@@ -488,7 +488,7 @@ Component Library: Object/cl_obj_mgr_destroy

       cl_obj_mgr_destroy
 

DESCRIPTION

-
       This routine destroys the object manager created through cl_obj_mgr_create.
+
       This routine destroys the object manager created through cl_obj_mgr_create.
 

SYNOPSIS

CL_EXPORT void CL_API
@@ -505,12 +505,12 @@ Component Library: Object/cl_obj_mgr_destroy
        objects that have not yet been destroyed.
 

SEE ALSO

-
       Object, cl_obj_mgr_create
+
       Object, cl_obj_mgr_create
 

-

[Structures] +

[Structures] Component Library: Object/cl_obj_mgr_t

[top][index]

@@ -532,18 +532,18 @@ Component Library: Object/cl_obj_mgr_t

SYNOPSIS

typedef struct _cl_obj_mgr
 {
-        cl_qlist_t                                      obj_list;
+        cl_qlist_t                                      obj_list;
         cl_spinlock_t                           lock;
 
-        cl_async_proc_t                         async_proc_mgr;
+        cl_async_proc_t                         async_proc_mgr;
 
-        cl_qpool_t                                      rel_pool;
+        cl_qpool_t                                      rel_pool;
 
 }       cl_obj_mgr_t;
 

FIELDS

       obj_list
-               List of all object's in the system.  Object's are inserted into this
+               List of all object's in the system.  Object's are inserted into this
                list when constructed and removed when freed.
 
        lock
@@ -561,14 +561,14 @@ Component Library: Object/cl_obj_mgr_t
                but are not required to do so.
 

SEE ALSO

-
       Object, cl_obj_mgr_create, cl_obj_mgr_destroy,
-       cl_obj_construct, cl_obj_deinit,
-       cl_qlist_t, cl_spinlock_t, cl_async_proc_t, cl_qpool_t
+
       Object, cl_obj_mgr_create, cl_obj_mgr_destroy,
+       cl_obj_construct, cl_obj_deinit,
+       cl_qlist_t, cl_spinlock_t, cl_async_proc_t, cl_qpool_t
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_ref

[top][index]

@@ -582,7 +582,7 @@ Component Library: Object/cl_obj_ref

SYNOPSIS

CL_EXPORT int32_t CL_API
 cl_obj_ref(
-        IN                              cl_obj_t * const                        p_obj );
+        IN                              cl_obj_t * const                        p_obj );
 

PARAMETERS

       p_obj
@@ -592,12 +592,12 @@ Component Library: Object/cl_obj_ref
 
       The updated reference count.
 

SEE ALSO

-
       Object, cl_obj_t, cl_obj_deref
+
       Object, cl_obj_t, cl_obj_deref
 

-

[Structures] +

[Structures] Component Library: Object/cl_obj_rel_t

[top][index]

@@ -610,10 +610,10 @@ Component Library: Object/cl_obj_rel_t

SYNOPSIS

typedef struct _cl_obj_rel
 {
-        cl_pool_item_t                          pool_item;              /* Must be first. */
+        cl_pool_item_t                          pool_item;              /* Must be first. */
         struct _cl_obj                          *p_parent_obj;
 
-        cl_list_item_t                          list_item;
+        cl_list_item_t                          list_item;
         struct _cl_obj                          *p_child_obj;
 
 }       cl_obj_rel_t;
@@ -643,17 +643,17 @@ Component Library: Object/cl_obj_rel_t
        Relationship items are stored in lists maintained by both the parent
        and child objects.  References to both objects exist while the
        relationship is maintained.  Typically, relationships are defined by
-       the user by calling cl_obj_insert_rel, but are destroyed automatically
+       the user by calling cl_obj_insert_rel, but are destroyed automatically
        via an object's destruction process.
 

SEE ALSO

-
       Object, cl_rel_alloc, cl_rel_free, cl_obj_insert_rel, cl_obj_remove_rel,
-       cl_obj_destroy
+
       Object, cl_rel_alloc, cl_rel_free, cl_obj_insert_rel, cl_obj_remove_rel,
+       cl_obj_destroy
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_remove_rel

[top][index]

@@ -666,7 +666,7 @@ Component Library: Object/cl_obj_remove_rel

SYNOPSIS

CL_EXPORT void CL_API
 cl_obj_remove_rel(
-        IN                              cl_obj_rel_t * const            p_rel );
+        IN                              cl_obj_rel_t * const            p_rel );
 

PARAMETERS

       p_rel
@@ -682,12 +682,12 @@ Component Library: Object/cl_obj_remove_rel
        destroyed, either directly or indirectly via a parent.
 

SEE ALSO

-
       Object, cl_rel_alloc, cl_rel_free, cl_obj_insert_rel, cl_obj_destroy
+
       Object, cl_rel_alloc, cl_rel_free, cl_obj_insert_rel, cl_obj_destroy
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_reset

[top][index]

@@ -695,14 +695,14 @@ Component Library: Object/cl_obj_reset

       cl_obj_reset
 

DESCRIPTION

-
       Reset an object's state.  This is called after cl_obj_destroy has
-       been called on a object, but before cl_obj_deinit has been invoked.
+
       Reset an object's state.  This is called after cl_obj_destroy has
+       been called on a object, but before cl_obj_deinit has been invoked.
        After an object has been reset, it is ready for re-use.
 

SYNOPSIS

CL_EXPORT void CL_API
 cl_obj_reset(
-        IN                              cl_obj_t * const                        p_obj );
+        IN                              cl_obj_t * const                        p_obj );
 

PARAMETERS

       p_obj
@@ -719,12 +719,12 @@ Component Library: Object/cl_obj_reset
        not be freed until the pool itself was destroyed.
 

SEE ALSO

-
       Object, cl_obj_destroy, cl_obj_free, cl_obj_t
+
       Object, cl_obj_destroy, cl_obj_free, cl_obj_t
 

-

[Structures] +

[Structures] Component Library: Object/cl_obj_t

[top][index]

@@ -732,27 +732,27 @@ Component Library: Object/cl_obj_t

       cl_obj_t
 

DESCRIPTION

-
       Object structure.
+
       Object structure.
 

SYNOPSIS

typedef struct _cl_obj
 {
-        cl_pool_item_t                          pool_item;      /* Must be first. */
+        cl_pool_item_t                          pool_item;      /* Must be first. */
         uint32_t                                        type;
         cl_state_t                                      state;
-        cl_destroy_type_t                       destroy_type;
+        cl_destroy_type_t                       destroy_type;
 
-        cl_async_proc_item_t            async_item;
+        cl_async_proc_item_t            async_item;
         cl_event_t                                      event;
 
-        cl_pfn_obj_call_t                       pfn_destroying;
-        cl_pfn_obj_call_t                       pfn_cleanup;
-        cl_pfn_obj_call_t                       pfn_free;
+        cl_pfn_obj_call_t                       pfn_destroying;
+        cl_pfn_obj_call_t                       pfn_cleanup;
+        cl_pfn_obj_call_t                       pfn_free;
 
         cl_spinlock_t                           lock;
 
-        cl_qlist_t                                      parent_list;
-        cl_qlist_t                                      child_list;
+        cl_qlist_t                                      parent_list;
+        cl_qlist_t                                      child_list;
 
         atomic32_t                                      ref_cnt;
 
@@ -781,7 +781,7 @@ Component Library: Object/cl_obj_t
                processing.
 
        event
-               Event used when destroying the object synchronously.  A call to destroy
+               Event used when destroying the object synchronously.  A call to destroy
                the object will wait on this event until the destruction has completed.
 
        pfn_destroying
@@ -800,7 +800,7 @@ Component Library: Object/cl_obj_t
        pfn_free
                User-specified callback invoked to notify a user that an object has
                been destroyed and is ready for deallocation.  Users should either
-               call cl_obj_deinit or cl_obj_reset from within this callback.
+               call cl_obj_deinit or cl_obj_reset from within this callback.
 
        lock
                A lock provided by the object.
@@ -818,15 +818,15 @@ Component Library: Object/cl_obj_t
                A count of the number of objects still referencing this object.
 

SEE ALSO

-
       Object, cl_obj_construct, cl_obj_init, cl_obj_destroy,
-       cl_obj_deinit, cl_pfn_obj_call_t, cl_destroy_type_t,
-       cl_pool_item_t, cl_state_t, cl_async_proc_item_t,
-       cl_event_t, cl_spinlock_t, cl_qlist_t, atomic32_t
+
       Object, cl_obj_construct, cl_obj_init, cl_obj_destroy,
+       cl_obj_deinit, cl_pfn_obj_call_t, cl_destroy_type_t,
+       cl_pool_item_t, cl_state_t, cl_async_proc_item_t,
+       cl_event_t, cl_spinlock_t, cl_qlist_t, atomic32_t
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_type

[top][index]

@@ -839,7 +839,7 @@ Component Library: Object/cl_obj_type

SYNOPSIS

CL_INLINE uint32_t CL_API
 cl_obj_type(
-        IN                              cl_obj_t * const                        p_obj )
+        IN                              cl_obj_t * const                        p_obj )
 {
         return p_obj->type;
 }
@@ -849,15 +849,15 @@ Component Library: Object/cl_obj_type
                [in] A pointer to the object whose type to return.
 

RETURN VALUE

-
       The type of the object, as specified in the call to cl_obj_init.
+
       The type of the object, as specified in the call to cl_obj_init.
 

SEE ALSO

-
       Object, cl_obj_t, cl_obj_init
+
       Object, cl_obj_t, cl_obj_init
 

-

[Functions] +

[Functions] Component Library: Object/cl_obj_unlock

[top][index]

@@ -865,16 +865,16 @@ Component Library: Object/cl_obj_unlock

       cl_obj_unlock
 

DESCRIPTION

-
       Releases an object's lock previously acquired by a call to cl_obj_lock.
+
       Releases an object's lock previously acquired by a call to cl_obj_lock.
 

SYNOPSIS

CL_INLINE void CL_API
 cl_obj_unlock(
-        IN                              cl_obj_t * const                        p_obj )
+        IN                              cl_obj_t * const                        p_obj )
 {
         CL_ASSERT( p_obj->state == CL_INITIALIZED ||
                 p_obj->state == CL_DESTROYING );
-        cl_spinlock_release( &p_obj->lock );
+        cl_spinlock_release( &p_obj->lock );
 }
 

PARAMETERS

@@ -885,12 +885,12 @@ Component Library: Object/cl_obj_unlock
       This function does not return a value.
 

SEE ALSO

-
       Object, cl_obj_t, cl_obj_lock
+
       Object, cl_obj_t, cl_obj_lock
 

-

[Definitions] +

[Definitions] Component Library: Object/cl_pfn_obj_call_t

[top][index]

@@ -908,7 +908,7 @@ Component Library: Object/cl_pfn_obj_call_t

PARAMETERS

       p_obj
-               [in] Pointer to a cl_obj_t.  This is the object being returned to
+               [in] Pointer to a cl_obj_t.  This is the object being returned to
                the user.
 
  RETURN VALUES
@@ -916,15 +916,15 @@ Component Library: Object/cl_pfn_obj_call_t
 

NOTES

       This function type is provided as a prototype for functions provided
-       by users as parameters to the cl_obj_init function.
+       by users as parameters to the cl_obj_init function.
 

SEE ALSO

-
       Object, cl_obj_init, cl_obj_t
+
       Object, cl_obj_init, cl_obj_t
 

-

[Functions] +

[Functions] Component Library: Object/cl_rel_alloc

[top][index]

@@ -935,7 +935,7 @@ Component Library: Object/cl_rel_alloc

       Retrieves an object relationship item from the object manager.
 

SYNOPSIS

-
CL_EXPORT cl_obj_rel_t* CL_API
+
CL_EXPORT cl_obj_rel_t* CL_API
 cl_rel_alloc(void);
 

PARAMETERS

@@ -946,21 +946,21 @@ Component Library: Object/cl_rel_alloc object could be allocated.

NOTES

-
       This routine retrieves a cl_obj_rel_t structure from a pool maintained
+
       This routine retrieves a cl_obj_rel_t structure from a pool maintained
        by the object manager.  The pool automatically grows as needed.
 
        Relationship items are used to describe a dependent relationship between
        a parent and child object.  In cases where a child has a fixed number of
-       relationships, the user may be able to allocate and manage the cl_obj_rel_t
+       relationships, the user may be able to allocate and manage the cl_obj_rel_t
        structures more efficiently than obtaining the structures through this call.
 

SEE ALSO

-
       Object, cl_rel_free, cl_obj_insert_rel, cl_obj_remove_rel, cl_obj_destroy
+
       Object, cl_rel_free, cl_obj_insert_rel, cl_obj_remove_rel, cl_obj_destroy
 

-

[Functions] +

[Functions] Component Library: Object/cl_rel_free

[top][index]

@@ -973,7 +973,7 @@ Component Library: Object/cl_rel_free

SYNOPSIS

CL_EXPORT void CL_API
 cl_rel_free(
-        IN                              cl_obj_rel_t * const            p_rel );
+        IN                              cl_obj_rel_t * const            p_rel );
 

PARAMETERS

       p_rel
@@ -985,12 +985,12 @@ Component Library: Object/cl_rel_free
 

NOTES

       Relationship items must not be freed until both the parent and child
        object have removed their references to one another.  Relationship items
-       may be freed after calling cl_obj_remove_rel or after the associated
+       may be freed after calling cl_obj_remove_rel or after the associated
        child object's free callback has been invoked.  In the latter case, the
        invalid relationship items are referenced by the child object's parent_list.
 

SEE ALSO

-
       Object, cl_rel_alloc, cl_obj_insert_rel, cl_obj_remove_rel, cl_obj_destroy
+
       Object, cl_rel_alloc, cl_obj_insert_rel, cl_obj_remove_rel, cl_obj_destroy
 
diff --git a/trunk/docs/complib/cl_passivelock_h.html b/trunk/docs/complib/cl_passivelock_h.html index 3e92115a..b37be9af 100644 --- a/trunk/docs/complib/cl_passivelock_h.html +++ b/trunk/docs/complib/cl_passivelock_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_passivelock_h.html +./inc_docs/complib/cl_passivelock_h.html -Generated from ./inc/complib/cl_passivelock.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_passivelock.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Passive Lock

-

[top][index]

+

[top][parent][index]

NAME

       Passive Lock
 
@@ -25,24 +25,24 @@ Component Library/Passive Lock Passive lock works exclusively between threads and cannot be used in situations where the caller cannot be put into a waiting state. - The passive lock functions operate a cl_plock_t structure which should + The passive lock functions operate a cl_plock_t structure which should be treated as opaque and should be manipulated only through the provided functions.

SEE ALSO

       Structures:
-               cl_plock_t
+               cl_plock_t
 
        Initialization:
-               cl_plock_construct, cl_plock_init, cl_plock_destroy
+               cl_plock_construct, cl_plock_init, cl_plock_destroy
 
        Manipulation
-               cl_plock_acquire, cl_plock_excl_acquire, cl_plock_release
+               cl_plock_acquire, cl_plock_excl_acquire, cl_plock_release
 

-

[Functions] +

[Functions] Component Library: Passive Lock/cl_plock_acquire

[top][index]

@@ -56,46 +56,46 @@ Component Library: Passive Lock/cl_plock_acquire

SYNOPSIS

CL_INLINE void CL_API
 cl_plock_acquire(
-        IN      cl_plock_t* const       p_lock )
+        IN      cl_plock_t* const       p_lock )
 {
-        cl_status_t     status;
+        cl_status_t     status;
 
         CL_ASSERT( p_lock );
 
         status =
-                cl_event_wait_on( &p_lock->reader_event, EVENT_NO_TIMEOUT, FALSE );
+                cl_event_wait_on( &p_lock->reader_event, EVENT_NO_TIMEOUT, FALSE );
         CL_ASSERT( status == CL_SUCCESS );
 
         /*
          * Increment the reader count to block a thread trying for exclusive
          * access.
          */
-        cl_atomic_inc( &p_lock->reader_count );
+        cl_atomic_inc( &p_lock->reader_count );
 #ifdef DBG_PASSIVE_LOCKS
-        cl_dbg_out( "cl_plock_acquire: ReaderCount = %u\n",
+        cl_dbg_out( "cl_plock_acquire: ReaderCount = %u\n",
                 p_lock->reader_count );
 #endif
         /*
          * Release the reader event to satisfy the wait of another reader
          * or a writer.
          */
-        cl_event_signal( &p_lock->reader_event );
+        cl_event_signal( &p_lock->reader_event );
 }
 

PARAMETERS

       p_lock
-               [in] Pointer to a cl_plock_t structure to acquire.
+               [in] Pointer to a cl_plock_t structure to acquire.
 

RETURN VALUE

       This function does not return a value.
 

SEE ALSO

-
       Passive Lock, cl_plock_release, cl_plock_excl_acquire
+
       Passive Lock, cl_plock_release, cl_plock_excl_acquire
 

-

[Functions] +

[Functions] Component Library: Passive Lock/cl_plock_construct

[top][index]

@@ -109,35 +109,35 @@ Component Library: Passive Lock/cl_plock_construct

SYNOPSIS

CL_INLINE void CL_API
 cl_plock_construct(
-        IN      cl_plock_t* const       p_lock )
+        IN      cl_plock_t* const       p_lock )
 {
         CL_ASSERT( p_lock );
 
         p_lock->reader_count = 0;
-        cl_event_construct( &p_lock->reader_event );
-        cl_event_construct( &p_lock->writer_event );
+        cl_event_construct( &p_lock->reader_event );
+        cl_event_construct( &p_lock->writer_event );
 }
 

PARAMETERS

       p_lock
-               [in] Pointer to a cl_plock_t structure whose state to initialize.
+               [in] Pointer to a cl_plock_t structure whose state to initialize.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       Allows calling cl_plock_destroy without first calling cl_plock_init.
+
       Allows calling cl_plock_destroy without first calling cl_plock_init.
 
        Calling cl_plock_construct is a prerequisite to calling any other
-       passive lock function except cl_plock_init.
+       passive lock function except cl_plock_init.
 

SEE ALSO

-
       Passive Lock, cl_plock_init, cl_plock_destroy
+
       Passive Lock, cl_plock_init, cl_plock_destroy
 

-

[Functions] +

[Functions] Component Library: Passive Lock/cl_plock_destroy

[top][index]

@@ -151,18 +151,18 @@ Component Library: Passive Lock/cl_plock_destroy

SYNOPSIS

CL_INLINE void CL_API
 cl_plock_destroy(
-        IN      cl_plock_t* const       p_lock )
+        IN      cl_plock_t* const       p_lock )
 {
         CL_ASSERT( p_lock );
         CL_ASSERT( p_lock->reader_count == 0 );
 
-        cl_event_destroy( &p_lock->writer_event );
-        cl_event_destroy( &p_lock->reader_event );
+        cl_event_destroy( &p_lock->writer_event );
+        cl_event_destroy( &p_lock->reader_event );
 }
 

PARAMETERS

       p_lock
-               [in] Pointer to a cl_plock_t structure whose state to initialize.
+               [in] Pointer to a cl_plock_t structure whose state to initialize.
 

RETURN VALUE

       This function does not return a value.
@@ -171,17 +171,17 @@ Component Library: Passive Lock/cl_plock_destroy
 
       cl_plock_destroy performs any necessary cleanup of the specified
        passive lock.
 
-       This function must only be called if cl_plock_construct or
-       cl_plock_init has been called. The passive lock must not be held
+       This function must only be called if cl_plock_construct or
+       cl_plock_init has been called. The passive lock must not be held
        when calling this function.
 

SEE ALSO

-
       Passive Lock, cl_plock_construct, cl_plock_init
+
       Passive Lock, cl_plock_construct, cl_plock_init
 

-

[Functions] +

[Functions] Component Library: Passive Lock/cl_plock_excl_acquire

[top][index]

@@ -195,48 +195,48 @@ Component Library: Passive Lock/cl_plock_excl_acquire

SYNOPSIS

CL_INLINE void CL_API
 cl_plock_excl_acquire(
-        IN      cl_plock_t* const       p_lock )
+        IN      cl_plock_t* const       p_lock )
 {
-        cl_status_t     status;
+        cl_status_t     status;
 
         CL_ASSERT( p_lock );
 
         /* Acquire the reader event.  This will block new readers. */
         status =
-                cl_event_wait_on( &p_lock->reader_event, EVENT_NO_TIMEOUT, FALSE );
+                cl_event_wait_on( &p_lock->reader_event, EVENT_NO_TIMEOUT, FALSE );
         CL_ASSERT( status == CL_SUCCESS );
 
         /* Wait for the writer event until all readers have exited. */
         while( p_lock->reader_count )
         {
 #ifdef DBG_PASSIVE_LOCKS
-                cl_dbg_out( "cl_plock_excl_acquire: ReaderCount = %u\n",
+                cl_dbg_out( "cl_plock_excl_acquire: ReaderCount = %u\n",
                         p_lock->reader_count );
 #endif
                 status =
-                        cl_event_wait_on( &p_lock->writer_event, EVENT_NO_TIMEOUT, FALSE );
+                        cl_event_wait_on( &p_lock->writer_event, EVENT_NO_TIMEOUT, FALSE );
                 CL_ASSERT( status == CL_SUCCESS );
         }
 
 #ifdef DBG_PASSIVE_LOCKS
-        cl_dbg_out( "cl_plock_excl_acquire: Exit\n" );
+        cl_dbg_out( "cl_plock_excl_acquire: Exit\n" );
 #endif
 }
 

PARAMETERS

       p_lock
-               [in] Pointer to a cl_plock_t structure to acquire exclusively.
+               [in] Pointer to a cl_plock_t structure to acquire exclusively.
 

RETURN VALUE

       This function does not return a value.
 

SEE ALSO

-
       Passive Lock, cl_plock_release, cl_plock_acquire
+
       Passive Lock, cl_plock_release, cl_plock_acquire
 

-

[Functions] +

[Functions] Component Library: Passive Lock/cl_plock_init

[top][index]

@@ -247,27 +247,27 @@ Component Library: Passive Lock/cl_plock_init

       The cl_plock_init function initializes a passive lock.
 

SYNOPSIS

-
CL_INLINE cl_status_t CL_API
+
CL_INLINE cl_status_t CL_API
 cl_plock_init(
-        IN      cl_plock_t* const       p_lock )
+        IN      cl_plock_t* const       p_lock )
 {
-        cl_status_t     status;
+        cl_status_t     status;
 
         CL_ASSERT( p_lock );
 
-        cl_plock_construct( p_lock );
+        cl_plock_construct( p_lock );
 
-        status = cl_event_init( &p_lock->writer_event, FALSE );
+        status = cl_event_init( &p_lock->writer_event, FALSE );
         if( status != CL_SUCCESS )
         {
-                cl_plock_destroy( p_lock );
+                cl_plock_destroy( p_lock );
                 return( status );
         }
 
-        status = cl_event_init( &p_lock->reader_event, FALSE );
+        status = cl_event_init( &p_lock->reader_event, FALSE );
         if( status != CL_SUCCESS )
         {
-                cl_plock_destroy( p_lock );
+                cl_plock_destroy( p_lock );
                 return( status );
         }
 
@@ -275,10 +275,10 @@ Component Library: Passive Lock/cl_plock_init
          * Set the writer event to signalled so that the first
          * wait operation succeeds.
          */
-        status = cl_event_signal( &p_lock->writer_event );
+        status = cl_event_signal( &p_lock->writer_event );
         if( status != CL_SUCCESS )
         {
-                cl_plock_destroy( p_lock );
+                cl_plock_destroy( p_lock );
                 return( status );
         }
 
@@ -286,10 +286,10 @@ Component Library: Passive Lock/cl_plock_init
          * Set the reader event to signalled so that the first
          * wait operation succeeds.
          */
-        status = cl_event_signal( &p_lock->reader_event );
+        status = cl_event_signal( &p_lock->reader_event );
         if( status != CL_SUCCESS )
         {
-                cl_plock_destroy( p_lock );
+                cl_plock_destroy( p_lock );
                 return( status );
         }
 
@@ -298,7 +298,7 @@ Component Library: Passive Lock/cl_plock_init
 

PARAMETERS

       p_lock
-               [in] Pointer to a cl_plock_t structure to initialize.
+               [in] Pointer to a cl_plock_t structure to initialize.
 
  RETURN VALUES
        CL_SUCCESS if the passive lock was initialized successfully.
@@ -306,18 +306,18 @@ Component Library: Passive Lock/cl_plock_init
        CL_ERROR otherwise.
 

NOTES

-
       Allows calling cl_plock_acquire, cl_plock_release,
-       cl_plock_excl_acquire, and cl_plock_excl_release.
+
       Allows calling cl_plock_acquire, cl_plock_release,
+       cl_plock_excl_acquire, and cl_plock_excl_release.
 

SEE ALSO

-
       Passive Lock, cl_plock_construct, cl_plock_destroy,
-       cl_plock_excl_acquire, cl_plock_excl_release,
-       cl_plock_acquire, cl_plock_release
+
       Passive Lock, cl_plock_construct, cl_plock_destroy,
+       cl_plock_excl_acquire, cl_plock_excl_release,
+       cl_plock_acquire, cl_plock_release
 

-

[Functions] +

[Functions] Component Library: Passive Lock/cl_plock_release

[top][index]

@@ -331,7 +331,7 @@ Component Library: Passive Lock/cl_plock_release

SYNOPSIS

CL_INLINE void CL_API
 cl_plock_release(
-        IN      cl_plock_t* const       p_lock )
+        IN      cl_plock_t* const       p_lock )
 {
         CL_ASSERT( p_lock );
 
@@ -342,42 +342,42 @@ Component Library: Passive Lock/cl_plock_release
                  * Decrement the count to allow a thread waiting for exclusive
                  * access to continue.
                  */
-                cl_atomic_dec( &p_lock->reader_count );
+                cl_atomic_dec( &p_lock->reader_count );
 
                 #ifdef DBG_PASSIVE_LOCKS
-                        cl_dbg_out( "cl_plock_release: ReaderCount = %u\n",
+                        cl_dbg_out( "cl_plock_release: ReaderCount = %u\n",
                                 p_lock->reader_count );
                 #endif
 
                 /* Release a writer, if any. */
-                cl_event_signal( &p_lock->writer_event );
+                cl_event_signal( &p_lock->writer_event );
         }
         else
         {
                 /* Release threads waiting to acquire the lock. */
-                cl_event_signal( &p_lock->reader_event );
-                cl_event_signal( &p_lock->writer_event );
+                cl_event_signal( &p_lock->reader_event );
+                cl_event_signal( &p_lock->writer_event );
 
                 #ifdef DBG_PASSIVE_LOCKS
-                        cl_dbg_out( "cl_plock_release: Exit\n" );
+                        cl_dbg_out( "cl_plock_release: Exit\n" );
                 #endif
         }
 }
 

PARAMETERS

       p_lock
-               [in] Pointer to a cl_plock_t structure to release.
+               [in] Pointer to a cl_plock_t structure to release.
 

RETURN VALUE

       This function does not return a value.
 

SEE ALSO

-
       Passive Lock, cl_plock_acquire, cl_plock_excl_acquire
+
       Passive Lock, cl_plock_acquire, cl_plock_excl_acquire
 

-

[Structures] +

[Structures] Component Library: Passive Lock/cl_plock_t

[top][index]

@@ -401,10 +401,10 @@ Component Library: Passive Lock/cl_plock_t

FIELDS

       reader_event
-               Event used to synchronize shared access to the lock.
+               Event used to synchronize shared access to the lock.
 
        writer_event
-               Event used to synchronize exclusive access to the lock.
+               Event used to synchronize exclusive access to the lock.
 
        reader_count
                Number of threads holding the lock for shared access.
diff --git a/trunk/docs/complib/cl_perf_h.html b/trunk/docs/complib/cl_perf_h.html
index 8b5de0fe..7343b94c 100644
--- a/trunk/docs/complib/cl_perf_h.html
+++ b/trunk/docs/complib/cl_perf_h.html
@@ -2,19 +2,19 @@
 
 
 
-./inc_doc/complib/cl_perf_h.html
+./inc_docs/complib/cl_perf_h.html
 
 
 
 
-Generated from ./inc/complib/cl_perf.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31
+Generated from ./inc/complib/cl_perf.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38
 

[Modules] Component Library/Performance Counters

-

[top][index]

+

[top][parent][index]

NAME

       Performance Counters
 
@@ -54,19 +54,19 @@ Component Library/Performance Counters cl_perf_t Initialization: - cl_perf_construct, cl_perf_init, cl_perf_destroy + cl_perf_construct, cl_perf_init, cl_perf_destroy Manipulation - cl_perf_reset, cl_perf_display, cl_perf_start, cl_perf_update, - cl_perf_log, cl_perf_stop + cl_perf_reset, cl_perf_display, cl_perf_start, cl_perf_update, + cl_perf_log, cl_perf_stop Macros: - PERF_DECLARE, PERF_DECLARE_START + PERF_DECLARE, PERF_DECLARE_START

-

[Definitions] +

[Definitions] Component Library: Performance Counters/cl_perf_clr

[top][index]

@@ -78,7 +78,7 @@ Component Library: Performance Counters/cl_perf_clr

SYNOPSIS

void
-cl_perf_inc(
+cl_perf_inc(
         IN      const uintn_t index );
 

PARAMETERS

@@ -89,13 +89,13 @@ Component Library: Performance Counters/cl_perf_clr
       This macro has no effect when performance counters are disabled.
 

SEE ALSO

-
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_log,
-       cl_perf_update, cl_perf_stop
+
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_log,
+       cl_perf_update, cl_perf_stop
 

-

[Functions] +

[Functions] Component Library: Performance Counters/cl_perf_construct

[top][index]

@@ -119,22 +119,22 @@ Component Library: Performance Counters/cl_perf_construct

       This function does not return a value.
 

NOTES

-
       cl_perf_construct allows calling cl_perf_destroy without first calling
-       cl_perf_init.
+
       cl_perf_construct allows calling cl_perf_destroy without first calling
+       cl_perf_init.
 
        Calling cl_perf_construct is a prerequisite to calling any other
-       perfromance counter function except cl_perf_init.
+       perfromance counter function except cl_perf_init.
 
        This function is implemented as a macro and has no effect when
        performance counters are disabled.
 

SEE ALSO

-
       Performance Counters, cl_perf_init, cl_perf_destroy
+
       Performance Counters, cl_perf_init, cl_perf_destroy
 

-

[Functions] +

[Functions] Component Library: Performance Counters/cl_perf_destroy

[top][index]

@@ -161,23 +161,23 @@ Component Library: Performance Counters/cl_perf_destroy

       This function does not return a value.
 

NOTES

-
       cl_perf_destroy frees all resources allocated in a call to cl_perf_init.
+
       cl_perf_destroy frees all resources allocated in a call to cl_perf_init.
        If the display parameter is set to TRUE, displays all counter values
        before deallocating resources.
 
-       This function should only be called after a call to cl_perf_construct
-       or cl_perf_init.
+       This function should only be called after a call to cl_perf_construct
+       or cl_perf_init.
 
        This function is implemented as a macro and has no effect when
        performance counters are disabled.
 

SEE ALSO

-
       Performance Counters, cl_perf_construct, cl_perf_init
+
       Performance Counters, cl_perf_construct, cl_perf_init
 

-

[Functions] +

[Functions] Component Library: Performance Counters/cl_perf_display

[top][index]

@@ -206,12 +206,12 @@ Component Library: Performance Counters/cl_perf_display

performance counters are disabled.

SEE ALSO

-
       Performance Counters, cl_perf_init
+
       Performance Counters, cl_perf_init
 

-

[Definitions] +

[Definitions] Component Library: Performance Counters/cl_perf_inc

[top][index]

@@ -234,13 +234,13 @@ Component Library: Performance Counters/cl_perf_inc

       This macro has no effect when performance counters are disabled.
 

SEE ALSO

-
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_log,
-       cl_perf_update, cl_perf_stop
+
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_log,
+       cl_perf_update, cl_perf_stop
 

-

[Functions] +

[Functions] Component Library: Performance Counters/cl_perf_init

[top][index]

@@ -252,7 +252,7 @@ Component Library: Performance Counters/cl_perf_init

for use.

SYNOPSIS

-
cl_status_t
+
cl_status_t
 cl_perf_init(
         IN      cl_perf_t* const        p_perf,
         IN      const uintn_t           num_counters );
@@ -283,12 +283,12 @@ Component Library: Performance Counters/cl_perf_init
        performance counters are disabled.
 

SEE ALSO

-
       Performance Counters, cl_perf_construct, cl_perf_destroy, cl_perf_display
+
       Performance Counters, cl_perf_construct, cl_perf_destroy, cl_perf_display
 

-

[Definitions] +

[Definitions] Component Library: Performance Counters/cl_perf_log

[top][index]

@@ -324,13 +324,13 @@ Component Library: Performance Counters/cl_perf_log

       This macro has no effect when performance counters are disabled.
 

SEE ALSO

-
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_start,
-       cl_perf_update, cl_perf_stop
+
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_start,
+       cl_perf_update, cl_perf_stop
 

-

[Functions] +

[Functions] Component Library: Performance Counters/cl_perf_reset

[top][index]

@@ -364,7 +364,7 @@ Component Library: Performance Counters/cl_perf_reset


-

[Definitions] +

[Definitions] Component Library: Performance Counters/cl_perf_start

[top][index]

@@ -387,13 +387,13 @@ Component Library: Performance Counters/cl_perf_start

       This macro has no effect when performance counters are disabled.
 

SEE ALSO

-
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_log,
-       cl_perf_update, cl_perf_stop
+
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_log,
+       cl_perf_update, cl_perf_stop
 

-

[Definitions] +

[Definitions] Component Library: Performance Counters/cl_perf_stop

[top][index]

@@ -401,7 +401,7 @@ Component Library: Performance Counters/cl_perf_stop

       cl_perf_stop
 

DESCRIPTION

-
       The cl_perf_log macro updates a counter in a performance counter
+
       The cl_perf_log macro updates a counter in a performance counter
        container with a new timing sample.
 

SYNOPSIS

@@ -428,13 +428,13 @@ Component Library: Performance Counters/cl_perf_stop This macro has no effect when performance counters are disabled.

SEE ALSO

-
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_start,
-       cl_perf_log
+
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_start,
+       cl_perf_log
 

-

[Definitions] +

[Definitions] Component Library: Performance Counters/cl_perf_update

[top][index]

@@ -470,13 +470,13 @@ Component Library: Performance Counters/cl_perf_update

       This macro has no effect when performance counters are disabled.
 

SEE ALSO

-
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_start,
-       cl_perf_lob, cl_perf_stop
+
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_start,
+       cl_perf_lob, cl_perf_stop
 

-

[Definitions] +

[Definitions] Component Library: Performance Counters/cl_perf_update_ctr

[top][index]

@@ -508,13 +508,13 @@ Component Library: Performance Counters/cl_perf_update_ctr

       This macro has no effect when performance counters are disabled.
 

SEE ALSO

-
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_start,
-       cl_perf_lob, cl_perf_stop
+
       Performance Counters, PERF_DECLARE, PERF_DECLARE_START, cl_perf_start,
+       cl_perf_lob, cl_perf_stop
 

-

[Definitions] +

[Definitions] Component Library: Performance Counters/PERF_DECLARE

[top][index]

@@ -543,13 +543,13 @@ Component Library: Performance Counters/PERF_DECLARE

This macro has no effect when performance counters are disabled.

SEE ALSO

-
       Performance Counters, PERF_DECLARE_START, cl_perf_start, cl_perf_log,
-       cl_perf_stop
+
       Performance Counters, PERF_DECLARE_START, cl_perf_start, cl_perf_log,
+       cl_perf_stop
 

-

[Definitions] +

[Definitions] Component Library: Performance Counters/PERF_DECLARE_START

[top][index]

@@ -575,8 +575,8 @@ Component Library: Performance Counters/PERF_DECLARE_START

This macro has no effect when performance counters are disabled.

SEE ALSO

-
       Performance Counters, PERF_DECLARE, cl_perf_start, cl_perf_log,
-       cl_perf_stop
+
       Performance Counters, PERF_DECLARE, cl_perf_start, cl_perf_log,
+       cl_perf_stop
 
diff --git a/trunk/docs/complib/cl_pool_h.html b/trunk/docs/complib/cl_pool_h.html index bec95335..d2bf71c6 100644 --- a/trunk/docs/complib/cl_pool_h.html +++ b/trunk/docs/complib/cl_pool_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_pool_h.html +./inc_docs/complib/cl_pool_h.html -Generated from ./inc/complib/cl_pool.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_pool.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Pool

-

[top][index]

+

[top][parent][index]

NAME

       Pool
 
@@ -31,29 +31,29 @@ Component Library/Pool objects to the pool. The only method of returning memory to the system is to destroy the pool. - The Pool functions operate on a cl_pool_t structure which should be treated + The Pool functions operate on a cl_pool_t structure which should be treated as opaque and should be manipulated only through the provided functions.

SEE ALSO

       Structures:
-               cl_pool_t
+               cl_pool_t
 
        Callbacks:
-               cl_pfn_pool_init_t, cl_pfn_pool_dtor_t
+               cl_pfn_pool_init_t, cl_pfn_pool_dtor_t
 
        Initialization/Destruction:
-               cl_pool_construct, cl_pool_init, cl_pool_destroy
+               cl_pool_construct, cl_pool_init, cl_pool_destroy
 
        Manipulation:
-               cl_pool_get, cl_pool_put, cl_pool_grow
+               cl_pool_get, cl_pool_put, cl_pool_grow
 
        Attributes:
-               cl_is_pool_inited, cl_pool_count
+               cl_is_pool_inited, cl_pool_count
 

-

[Functions] +

[Functions] Component Library: Pool/cl_is_pool_inited

[top][index]

@@ -67,16 +67,16 @@ Component Library: Pool/cl_is_pool_inited

SYNOPSIS

CL_INLINE uint32_t CL_API
 cl_is_pool_inited(
-        IN      const cl_pool_t* const  p_pool )
+        IN      const cl_pool_t* const  p_pool )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_pool );
-        return( cl_is_qcpool_inited( &p_pool->qcpool ) );
+        return( cl_is_qcpool_inited( &p_pool->qcpool ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_pool_t structure whose initialization state
+               [in] Pointer to a cl_pool_t structure whose initialization state
                to check.
 
  RETURN VALUES
@@ -94,7 +94,7 @@ Component Library: Pool/cl_is_pool_inited
 
 
-

[Definitions] +

[Definitions] Component Library: Pool/cl_pfn_pool_dtor_t

[top][index]

@@ -117,7 +117,7 @@ Component Library: Pool/cl_pfn_pool_dtor_t

[in] Pointer to an object to destruct. context - [in] Context provided in the call to cl_pool_init. + [in] Context provided in the call to cl_pool_init.

RETURN VALUE

       This function does not return a value.
@@ -125,7 +125,7 @@ Component Library: Pool/cl_pfn_pool_dtor_t
 

NOTES

       This function type is provided as function prototype reference for
        the function provided by the user as an optional parameter to the
-       cl_pool_init function.
+       cl_pool_init function.
 
        The destructor is invoked once per allocated object, allowing the user
        to perform any necessary cleanup. Users should not attempt to deallocate
@@ -133,12 +133,12 @@ Component Library: Pool/cl_pfn_pool_dtor_t
        allocation and deallocation.
 

SEE ALSO

-
       Pool, cl_pool_init
+
       Pool, cl_pool_init
 

-

[Definitions] +

[Definitions] Component Library: Pool/cl_pfn_pool_init_t

[top][index]

@@ -151,7 +151,7 @@ Component Library: Pool/cl_pfn_pool_init_t

pool.

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_pool_init_t)(
         IN      void* const                     p_object,
         IN      void*                           context );
@@ -161,34 +161,34 @@ Component Library: Pool/cl_pfn_pool_init_t
                [in] Pointer to an object to initialize.
 
        context
-               [in] Context provided in a call to cl_pool_init.
+               [in] Context provided in a call to cl_pool_init.
 
  RETURN VALUES
        Return CL_SUCCESS to indicates that initialization of the object
        was successful and initialization of further objects may continue.
 
-       Other cl_status_t values will be returned by cl_pool_init
-       and cl_pool_grow.
+       Other cl_status_t values will be returned by cl_pool_init
+       and cl_pool_grow.
 

NOTES

       This function type is provided as function prototype reference for
        the function provided by the user as an optional parameter to the
-       cl_pool_init function.
+       cl_pool_init function.
 
        The initializer is invoked once per allocated object, allowing the user
        to trap initialization failures. Returning a status other than CL_SUCCESS
-       aborts a grow operation, initiated either through cl_pool_init or
-       cl_pool_grow, and causes the initiating function to fail.
+       aborts a grow operation, initiated either through cl_pool_init or
+       cl_pool_grow, and causes the initiating function to fail.
        Any non-CL_SUCCESS status will be returned by the function that initiated
        the grow operation.
 

SEE ALSO

-
       Pool, cl_pool_init, cl_pool_grow
+
       Pool, cl_pool_init, cl_pool_grow
 

-

[Functions] +

[Functions] Component Library: Pool/cl_pool_construct

[top][index]

@@ -201,28 +201,28 @@ Component Library: Pool/cl_pool_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_pool_construct(
-        IN      cl_pool_t* const        p_pool );
+        IN      cl_pool_t* const        p_pool );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_pool_t structure whose state to initialize.
+               [in] Pointer to a cl_pool_t structure whose state to initialize.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       Allows calling cl_pool_init, cl_pool_destroy, and cl_is_pool_inited.
+
       Allows calling cl_pool_init, cl_pool_destroy, and cl_is_pool_inited.
 
        Calling cl_pool_construct is a prerequisite to calling any other
-       pool function except cl_pool_init.
+       pool function except cl_pool_init.
 

SEE ALSO

-
       Pool, cl_pool_init, cl_pool_destroy, cl_is_pool_inited
+
       Pool, cl_pool_init, cl_pool_destroy, cl_is_pool_inited
 

-

[Functions] +

[Functions] Component Library: Pool/cl_pool_count

[top][index]

@@ -236,15 +236,15 @@ Component Library: Pool/cl_pool_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_pool_count(
-        IN      cl_pool_t* const        p_pool )
+        IN      cl_pool_t* const        p_pool )
 {
         CL_ASSERT( p_pool );
-        return( cl_qcpool_count( &p_pool->qcpool ) );
+        return( cl_qcpool_count( &p_pool->qcpool ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_pool_t structure for which the number of
+               [in] Pointer to a cl_pool_t structure for which the number of
                available objects is requested.
 

RETURN VALUE

@@ -256,7 +256,7 @@ Component Library: Pool/cl_pool_count
-

[Functions] +

[Functions] Component Library: Pool/cl_pool_destroy

[top][index]

@@ -269,15 +269,15 @@ Component Library: Pool/cl_pool_destroy

SYNOPSIS

CL_INLINE void CL_API
 cl_pool_destroy(
-        IN      cl_pool_t* const        p_pool )
+        IN      cl_pool_t* const        p_pool )
 {
         CL_ASSERT( p_pool );
-        cl_qcpool_destroy( &p_pool->qcpool );
+        cl_qcpool_destroy( &p_pool->qcpool );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_pool_t structure to destroy.
+               [in] Pointer to a cl_pool_t structure to destroy.
 

RETURN VALUE

       This function does not return a value.
@@ -289,18 +289,18 @@ Component Library: Pool/cl_pool_destroy
        is invoked.
 
        This function should only be called after a call to
-       cl_pool_construct or cl_pool_init.
+       cl_pool_construct or cl_pool_init.
 
        In a debug build, cl_pool_destroy asserts that all objects are in
        the pool.
 

SEE ALSO

-
       Pool, cl_pool_construct, cl_pool_init
+
       Pool, cl_pool_construct, cl_pool_init
 

-

[Functions] +

[Functions] Component Library: Pool/cl_pool_get

[top][index]

@@ -313,13 +313,13 @@ Component Library: Pool/cl_pool_get

SYNOPSIS

CL_INLINE void* CL_API
 cl_pool_get(
-        IN      cl_pool_t* const        p_pool )
+        IN      cl_pool_t* const        p_pool )
 {
         cl_pool_obj_t   *p_pool_obj;
 
         CL_ASSERT( p_pool );
 
-        p_pool_obj = (cl_pool_obj_t*)cl_qcpool_get( &p_pool->qcpool );
+        p_pool_obj = (cl_pool_obj_t*)cl_qcpool_get( &p_pool->qcpool );
         if( !p_pool_obj )
                 return( NULL );
 
@@ -329,7 +329,7 @@ Component Library: Pool/cl_pool_get
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_pool_t structure from which to retrieve
+               [in] Pointer to a cl_pool_t structure from which to retrieve
                an object.
 
  RETURN VALUES
@@ -340,15 +340,15 @@ Component Library: Pool/cl_pool_get
 

NOTES

       cl_pool_get returns the object at the head of the pool. If the pool is
        empty, it is automatically grown to accommodate this request unless the
-       grow_size parameter passed to the cl_pool_init function was zero.
+       grow_size parameter passed to the cl_pool_init function was zero.
 

SEE ALSO

-
       Pool, cl_pool_get_tail, cl_pool_put, cl_pool_grow, cl_pool_count
+
       Pool, cl_pool_get_tail, cl_pool_put, cl_pool_grow, cl_pool_count
 

-

[Functions] +

[Functions] Component Library: Pool/cl_pool_grow

[top][index]

@@ -360,18 +360,18 @@ Component Library: Pool/cl_pool_grow

the specified number of objects.

SYNOPSIS

-
CL_INLINE cl_status_t CL_API
+
CL_INLINE cl_status_t CL_API
 cl_pool_grow(
-        IN      cl_pool_t* const        p_pool,
+        IN      cl_pool_t* const        p_pool,
         IN      const size_t            obj_count )
 {
         CL_ASSERT( p_pool );
-        return( cl_qcpool_grow( &p_pool->qcpool, obj_count ) );
+        return( cl_qcpool_grow( &p_pool->qcpool, obj_count ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_pool_t structure whose capacity to grow.
+               [in] Pointer to a cl_pool_t structure whose capacity to grow.
 
        obj_count
                [in] Number of objects by which to grow the pool.
@@ -382,9 +382,9 @@ Component Library: Pool/cl_pool_grow
        CL_INSUFFICIENT_MEMORY if there was not enough memory to grow the
        pool.
 
-       cl_status_t value returned by optional initialization callback function
+       cl_status_t value returned by optional initialization callback function
        specified by the pfn_initializer parameter passed to the
-       cl_pool_init function.
+       cl_pool_init function.
 

NOTES

       It is not necessary to call cl_pool_grow if the pool is
@@ -396,7 +396,7 @@ Component Library: Pool/cl_pool_grow
 
 
-

[Functions] +

[Functions] Component Library: Pool/cl_pool_init

[top][index]

@@ -407,20 +407,20 @@ Component Library: Pool/cl_pool_init

       The cl_pool_init function initializes a pool for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_pool_init(
-        IN      cl_pool_t* const                p_pool,
+        IN      cl_pool_t* const                p_pool,
         IN      const size_t                    min_count,
         IN      const size_t                    max_count,
         IN      const size_t                    grow_size,
         IN      const size_t                    object_size,
-        IN      cl_pfn_pool_init_t              pfn_initializer OPTIONAL,
-        IN      cl_pfn_pool_dtor_t              pfn_destructor OPTIONAL,
+        IN      cl_pfn_pool_init_t              pfn_initializer OPTIONAL,
+        IN      cl_pfn_pool_dtor_t              pfn_destructor OPTIONAL,
         IN      const void* const               context );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_pool_t structure to initialize.
+               [in] Pointer to a cl_pool_t structure to initialize.
 
        min_count
                [in] Minimum number of objects that the pool should support. All
@@ -442,13 +442,13 @@ Component Library: Pool/cl_pool_init
        pfn_initializer
                [in] Initialization callback to invoke for every new object when
                growing the pool. This parameter is optional and may be NULL.
-               See the cl_pfn_pool_init_t function type declaration for details
+               See the cl_pfn_pool_init_t function type declaration for details
                about the callback function.
 
        pfn_destructor
                [in] Destructor callback to invoke for every object before memory for
                that object is freed. This parameter is optional and may be NULL.
-               See the cl_pfn_pool_dtor_t function type declaration for details
+               See the cl_pfn_pool_dtor_t function type declaration for details
                about the callback function.
 
        context
@@ -463,7 +463,7 @@ Component Library: Pool/cl_pool_init
        CL_INVALID_SETTING if a the maximum size is non-zero and less than the
        minimum size.
 
-       Other cl_status_t value returned by optional initialization callback function
+       Other cl_status_t value returned by optional initialization callback function
        specified by the pfn_initializer parameter.
 

NOTES

@@ -471,14 +471,14 @@ Component Library: Pool/cl_pool_init the capacity desired.

SEE ALSO

-
       Pool, cl_pool_construct, cl_pool_destroy,
-       cl_pool_get, cl_pool_put, cl_pool_grow,
-       cl_pool_count, cl_pfn_pool_init_t, cl_pfn_pool_dtor_t
+
       Pool, cl_pool_construct, cl_pool_destroy,
+       cl_pool_get, cl_pool_put, cl_pool_grow,
+       cl_pool_count, cl_pfn_pool_init_t, cl_pfn_pool_dtor_t
 

-

[Functions] +

[Functions] Component Library: Pool/cl_pool_put

[top][index]

@@ -491,7 +491,7 @@ Component Library: Pool/cl_pool_put

SYNOPSIS

CL_INLINE void CL_API
 cl_pool_put(
-        IN      cl_pool_t* const        p_pool,
+        IN      cl_pool_t* const        p_pool,
         IN      void* const                     p_object )
 {
         cl_pool_obj_t   *p_pool_obj;
@@ -506,12 +506,12 @@ Component Library: Pool/cl_pool_put
         /* good sanity check */
         CL_ASSERT( p_pool_obj->list_obj.p_object == p_object );
 
-        cl_qcpool_put( &p_pool->qcpool, (cl_pool_item_t*)p_pool_obj );
+        cl_qcpool_put( &p_pool->qcpool, (cl_pool_item_t*)p_pool_obj );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_pool_t structure to which to return
+               [in] Pointer to a cl_pool_t structure to which to return
                an object.
 
        p_object
@@ -524,15 +524,15 @@ Component Library: Pool/cl_pool_put
 
       cl_pool_put places the returned object at the head of the pool.
 
        The object specified by the p_object parameter must have been
-       retrieved from the pool by a previous call to cl_pool_get.
+       retrieved from the pool by a previous call to cl_pool_get.
 

SEE ALSO

-
       Pool, cl_pool_put_tail, cl_pool_get
+
       Pool, cl_pool_put_tail, cl_pool_get
 

-

[Structures] +

[Structures] Component Library: Pool/cl_pool_t

[top][index]

@@ -548,9 +548,9 @@ Component Library: Pool/cl_pool_t

SYNOPSIS

typedef struct _cl_pool
 {
-        cl_qcpool_t                             qcpool;
-        cl_pfn_pool_init_t              pfn_init;
-        cl_pfn_pool_dtor_t              pfn_dtor;
+        cl_qcpool_t                             qcpool;
+        cl_pfn_pool_init_t              pfn_init;
+        cl_pfn_pool_dtor_t              pfn_dtor;
         const void                              *context;
 
 } cl_pool_t;
diff --git a/trunk/docs/complib/cl_ptr_vector_h.html b/trunk/docs/complib/cl_ptr_vector_h.html
index 02ab62fb..699fb63c 100644
--- a/trunk/docs/complib/cl_ptr_vector_h.html
+++ b/trunk/docs/complib/cl_ptr_vector_h.html
@@ -2,19 +2,19 @@
 
 
 
-./inc_doc/complib/cl_ptr_vector_h.html
+./inc_docs/complib/cl_ptr_vector_h.html
 
 
 
 
-Generated from ./inc/complib/cl_ptr_vector.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31
+Generated from ./inc/complib/cl_ptr_vector.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38
 

[Modules] Component Library/Pointer Vector

-

[top][index]

+

[top][parent][index]

NAME

       Pointer Vector
 
@@ -29,30 +29,30 @@ Component Library/Pointer Vector

SEE ALSO

       Structures:
-               cl_ptr_vector_t
+               cl_ptr_vector_t
 
        Callbacks:
-               cl_pfn_ptr_vec_apply_t, cl_pfn_ptr_vec_find_t
+               cl_pfn_ptr_vec_apply_t, cl_pfn_ptr_vec_find_t
 
        Item Manipulation:
                cl_ptr_vector_set_obj, cl_ptr_vector_obj
 
        Initialization:
-               cl_ptr_vector_construct, cl_ptr_vector_init, cl_ptr_vector_destroy
+               cl_ptr_vector_construct, cl_ptr_vector_init, cl_ptr_vector_destroy
 
        Manipulation:
-               cl_ptr_vector_get_capacity, cl_ptr_vector_set_capacity,
-               cl_ptr_vector_get_size, cl_ptr_vector_set_size, cl_ptr_vector_set_min_size
-               cl_ptr_vector_get_ptr, cl_ptr_vector_get, cl_ptr_vector_at, cl_ptr_vector_set
+               cl_ptr_vector_get_capacity, cl_ptr_vector_set_capacity,
+               cl_ptr_vector_get_size, cl_ptr_vector_set_size, cl_ptr_vector_set_min_size
+               cl_ptr_vector_get_ptr, cl_ptr_vector_get, cl_ptr_vector_at, cl_ptr_vector_set
 
        Search:
-               cl_ptr_vector_find_from_start, cl_ptr_vector_find_from_end
-               cl_ptr_vector_apply_func
+               cl_ptr_vector_find_from_start, cl_ptr_vector_find_from_end
+               cl_ptr_vector_apply_func
 

-

[Definitions] +

[Definitions] Component Library: Pointer Vector/cl_pfn_ptr_vec_apply_t

[top][index]

@@ -78,23 +78,23 @@ Component Library: Pointer Vector/cl_pfn_ptr_vec_apply_t

[in] Pointer to an element at the specified index in the pointer vector. context - [in] Context provided in a call to cl_ptr_vector_apply_func. + [in] Context provided in a call to cl_ptr_vector_apply_func.

RETURN VALUE

       This function does not return a value.
 

NOTES

       This function type is provided as function prototype reference for
-       the function passed by users as a parameter to the cl_ptr_vector_apply_func
+       the function passed by users as a parameter to the cl_ptr_vector_apply_func
        function.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_apply_func
+
       Pointer Vector, cl_ptr_vector_apply_func
 

-

[Definitions] +

[Definitions] Component Library: Pointer Vector/cl_pfn_ptr_vec_find_t

[top][index]

@@ -106,7 +106,7 @@ Component Library: Pointer Vector/cl_pfn_ptr_vec_find_t

functions used to find elements in a pointer vector.

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_ptr_vec_find_t)(
         IN      const size_t            index,
         IN      const void* const       element,
@@ -121,8 +121,8 @@ Component Library: Pointer Vector/cl_pfn_ptr_vec_find_t
                pointer vector.
 
        context
-               [in] Context provided in a call to cl_ptr_vector_find_from_start or
-               cl_ptr_vector_find_from_end.
+               [in] Context provided in a call to cl_ptr_vector_find_from_start or
+               cl_ptr_vector_find_from_end.
 
  RETURN VALUES
        Return CL_SUCCESS if the element was found. This stops pointer vector
@@ -133,15 +133,15 @@ Component Library: Pointer Vector/cl_pfn_ptr_vec_find_t
 

NOTES

       This function type is provided as function prototype reference for the
        function provided by users as a parameter to the
-       cl_ptr_vector_find_from_start and cl_ptr_vector_find_from_end functions.
+       cl_ptr_vector_find_from_start and cl_ptr_vector_find_from_end functions.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_find_from_start, cl_ptr_vector_find_from_end
+
       Pointer Vector, cl_ptr_vector_find_from_start, cl_ptr_vector_find_from_end
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_apply_func

[top][index]

@@ -155,17 +155,17 @@ Component Library: Pointer Vector/cl_ptr_vector_apply_func

SYNOPSIS

CL_EXPORT void CL_API
 cl_ptr_vector_apply_func(
-        IN      const cl_ptr_vector_t* const    p_vector,
-        IN      cl_pfn_ptr_vec_apply_t                  pfn_callback,
+        IN      const cl_ptr_vector_t* const    p_vector,
+        IN      cl_pfn_ptr_vec_apply_t                  pfn_callback,
         IN      const void* const                               context );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure whose elements to iterate.
+               [in] Pointer to a cl_ptr_vector_t structure whose elements to iterate.
 
        pfn_callback
                [in] Function invoked for every element in the array.
-               See the cl_pfn_ptr_vec_apply_t function type declaration for details
+               See the cl_pfn_ptr_vec_apply_t function type declaration for details
                about the callback function.
 
        context
@@ -179,13 +179,13 @@ Component Library: Pointer Vector/cl_ptr_vector_apply_func
        in the pointer vector, starting from the beginning of the pointer vector.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_find_from_start, cl_ptr_vector_find_from_end,
-       cl_pfn_ptr_vec_apply_t
+
       Pointer Vector, cl_ptr_vector_find_from_start, cl_ptr_vector_find_from_end,
+       cl_pfn_ptr_vec_apply_t
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_at

[top][index]

@@ -197,15 +197,15 @@ Component Library: Pointer Vector/cl_ptr_vector_at

vector at a specified index, performing boundary checks.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_ptr_vector_at(
-        IN      const cl_ptr_vector_t* const    p_vector,
+        IN      const cl_ptr_vector_t* const    p_vector,
         IN      const size_t                                    index,
         OUT     void** const                                    p_element );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure from which to get a copy of
+               [in] Pointer to a cl_ptr_vector_t structure from which to get a copy of
                an element.
 
        index
@@ -228,12 +228,12 @@ Component Library: Pointer Vector/cl_ptr_vector_at
        desired element.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_get
+
       Pointer Vector, cl_ptr_vector_get
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_construct

[top][index]

@@ -246,29 +246,29 @@ Component Library: Pointer Vector/cl_ptr_vector_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_ptr_vector_construct(
-        IN      cl_ptr_vector_t* const  p_vector );
+        IN      cl_ptr_vector_t* const  p_vector );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure to construct.
+               [in] Pointer to a cl_ptr_vector_t structure to construct.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       Allows calling cl_ptr_vector_destroy without first calling
-       cl_ptr_vector_init.
+
       Allows calling cl_ptr_vector_destroy without first calling
+       cl_ptr_vector_init.
 
        Calling cl_ptr_vector_construct is a prerequisite to calling any other
-       pointer vector function except cl_ptr_vector_init.
+       pointer vector function except cl_ptr_vector_init.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_init, cl_ptr_vector_destroy
+
       Pointer Vector, cl_ptr_vector_init, cl_ptr_vector_destroy
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_destroy

[top][index]

@@ -281,11 +281,11 @@ Component Library: Pointer Vector/cl_ptr_vector_destroy

SYNOPSIS

CL_EXPORT void CL_API
 cl_ptr_vector_destroy(
-        IN      cl_ptr_vector_t* const  p_vector );
+        IN      cl_ptr_vector_t* const  p_vector );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure to destroy.
+               [in] Pointer to a cl_ptr_vector_t structure to destroy.
 

RETURN VALUE

       This function does not return a value.
@@ -293,16 +293,16 @@ Component Library: Pointer Vector/cl_ptr_vector_destroy
 

NOTES

       cl_ptr_vector_destroy frees all memory allocated for the pointer vector.
 
-       This function should only be called after a call to cl_ptr_vector_construct
-       or cl_ptr_vector_init.
+       This function should only be called after a call to cl_ptr_vector_construct
+       or cl_ptr_vector_init.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_construct, cl_ptr_vector_init
+
       Pointer Vector, cl_ptr_vector_construct, cl_ptr_vector_init
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_find_from_end

[top][index]

@@ -316,17 +316,17 @@ Component Library: Pointer Vector/cl_ptr_vector_find_from_end

SYNOPSIS

CL_EXPORT size_t CL_API
 cl_ptr_vector_find_from_end(
-        IN      const cl_ptr_vector_t* const    p_vector,
-        IN      cl_pfn_ptr_vec_find_t                   pfn_callback,
+        IN      const cl_ptr_vector_t* const    p_vector,
+        IN      cl_pfn_ptr_vec_find_t                   pfn_callback,
         IN      const void* const                               context );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure to inititalize.
+               [in] Pointer to a cl_ptr_vector_t structure to inititalize.
 
        pfn_callback
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_ptr_vec_find_t function type declaration for details
+               See the cl_pfn_ptr_vec_find_t function type declaration for details
                about the callback function.
 
        context
@@ -343,13 +343,13 @@ Component Library: Pointer Vector/cl_ptr_vector_find_from_end
        provided by the pfn_callback parameter returns CL_SUCCESS.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_find_from_start, cl_ptr_vector_apply_func,
-       cl_pfn_ptr_vec_find_t
+
       Pointer Vector, cl_ptr_vector_find_from_start, cl_ptr_vector_apply_func,
+       cl_pfn_ptr_vec_find_t
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_find_from_start

[top][index]

@@ -363,17 +363,17 @@ Component Library: Pointer Vector/cl_ptr_vector_find_from_start

SYNOPSIS

CL_EXPORT size_t CL_API
 cl_ptr_vector_find_from_start(
-        IN      const cl_ptr_vector_t* const    p_vector,
-        IN      cl_pfn_ptr_vec_find_t                   pfn_callback,
+        IN      const cl_ptr_vector_t* const    p_vector,
+        IN      cl_pfn_ptr_vec_find_t                   pfn_callback,
         IN      const void* const                               context );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure to inititalize.
+               [in] Pointer to a cl_ptr_vector_t structure to inititalize.
 
        pfn_callback
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_ptr_vec_find_t function type declaration for details
+               See the cl_pfn_ptr_vec_find_t function type declaration for details
                about the callback function.
 
        context
@@ -390,13 +390,13 @@ Component Library: Pointer Vector/cl_ptr_vector_find_from_start
        provided by the pfn_callback parameter returns CL_SUCCESS.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_find_from_end, cl_ptr_vector_apply_func,
-       cl_pfn_ptr_vec_find_t
+
       Pointer Vector, cl_ptr_vector_find_from_end, cl_ptr_vector_apply_func,
+       cl_pfn_ptr_vec_find_t
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_get

[top][index]

@@ -410,7 +410,7 @@ Component Library: Pointer Vector/cl_ptr_vector_get

SYNOPSIS

CL_INLINE void* CL_API
 cl_ptr_vector_get(
-        IN      const cl_ptr_vector_t* const    p_vector,
+        IN      const cl_ptr_vector_t* const    p_vector,
         IN      const size_t                                    index )
 {
         CL_ASSERT( p_vector );
@@ -422,7 +422,7 @@ Component Library: Pointer Vector/cl_ptr_vector_get
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure from which to get an
+               [in] Pointer to a cl_ptr_vector_t structure from which to get an
                element.
 
        index
@@ -439,12 +439,12 @@ Component Library: Pointer Vector/cl_ptr_vector_get
        vector.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_at, cl_ptr_vector_set, cl_ptr_vector_get_size
+
       Pointer Vector, cl_ptr_vector_at, cl_ptr_vector_set, cl_ptr_vector_get_size
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_get_capacity

[top][index]

@@ -458,7 +458,7 @@ Component Library: Pointer Vector/cl_ptr_vector_get_capacity

SYNOPSIS

CL_INLINE size_t CL_API
 cl_ptr_vector_get_capacity(
-        IN      const cl_ptr_vector_t* const    p_vector )
+        IN      const cl_ptr_vector_t* const    p_vector )
 {
         CL_ASSERT( p_vector );
         CL_ASSERT( p_vector->state == CL_INITIALIZED );
@@ -468,7 +468,7 @@ Component Library: Pointer Vector/cl_ptr_vector_get_capacity
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure whose capacity to return.
+               [in] Pointer to a cl_ptr_vector_t structure whose capacity to return.
 

RETURN VALUE

       Capacity, in elements, of the pointer vector.
@@ -476,15 +476,15 @@ Component Library: Pointer Vector/cl_ptr_vector_get_capacity
 

NOTES

       The capacity is the number of elements that the pointer vector can store,
        and can be greater than the number of elements stored. To get the number
-       of elements stored in the pointer vector, use cl_ptr_vector_get_size.
+       of elements stored in the pointer vector, use cl_ptr_vector_get_size.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_set_capacity, cl_ptr_vector_get_size
+
       Pointer Vector, cl_ptr_vector_set_capacity, cl_ptr_vector_get_size
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_get_size

[top][index]

@@ -497,7 +497,7 @@ Component Library: Pointer Vector/cl_ptr_vector_get_size

SYNOPSIS

CL_INLINE size_t CL_API
 cl_ptr_vector_get_size(
-        IN      const cl_ptr_vector_t* const    p_vector )
+        IN      const cl_ptr_vector_t* const    p_vector )
 {
         CL_ASSERT( p_vector );
         CL_ASSERT( p_vector->state == CL_UNINITIALIZED ||
@@ -508,18 +508,18 @@ Component Library: Pointer Vector/cl_ptr_vector_get_size
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure whose size to return.
+               [in] Pointer to a cl_ptr_vector_t structure whose size to return.
 

RETURN VALUE

       Size, in elements, of the pointer vector.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_set_size, cl_ptr_vector_get_capacity
+
       Pointer Vector, cl_ptr_vector_set_size, cl_ptr_vector_get_capacity
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_init

[top][index]

@@ -530,15 +530,15 @@ Component Library: Pointer Vector/cl_ptr_vector_init

       The cl_ptr_vector_init function initializes a pointer vector for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_ptr_vector_init(
-        IN      cl_ptr_vector_t* const  p_vector,
+        IN      cl_ptr_vector_t* const  p_vector,
         IN      const size_t                    min_cap,
         IN      const size_t                    grow_size );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure to inititalize.
+               [in] Pointer to a cl_ptr_vector_t structure to inititalize.
 
        min_cap
                [in] Initial number of elements the vector will support.
@@ -554,13 +554,13 @@ Component Library: Pointer Vector/cl_ptr_vector_init
        CL_INSUFFICIENT_MEMORY if the initialization failed.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_construct, cl_ptr_vector_destroy,
-       cl_ptr_vector_set, cl_ptr_vector_get, cl_ptr_vector_at
+
       Pointer Vector, cl_ptr_vector_construct, cl_ptr_vector_destroy,
+       cl_ptr_vector_set, cl_ptr_vector_get, cl_ptr_vector_at
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_insert

[top][index]

@@ -571,18 +571,18 @@ Component Library: Pointer Vector/cl_ptr_vector_insert

       The cl_ptr_vector_insert function inserts an element into a pointer vector.
 

SYNOPSIS

-
CL_INLINE cl_status_t CL_API
+
CL_INLINE cl_status_t CL_API
 cl_ptr_vector_insert(
-        IN      cl_ptr_vector_t* const  p_vector,
+        IN      cl_ptr_vector_t* const  p_vector,
         IN      const void* const               element,
         OUT     size_t* const                   p_index OPTIONAL )
 {
-        cl_status_t             status;
+        cl_status_t             status;
 
         CL_ASSERT( p_vector );
         CL_ASSERT( p_vector->state == CL_INITIALIZED );
 
-        status = cl_ptr_vector_set( p_vector, p_vector->size, element );
+        status = cl_ptr_vector_set( p_vector, p_vector->size, element );
         if( status == CL_SUCCESS && p_index )
                 *p_index = p_vector->size - 1;
 
@@ -591,7 +591,7 @@ Component Library: Pointer Vector/cl_ptr_vector_insert
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure into which to store
+               [in] Pointer to a cl_ptr_vector_t structure into which to store
                an element.
 
        element
@@ -613,15 +613,15 @@ Component Library: Pointer Vector/cl_ptr_vector_insert
 
        cl_ptr_vector_insert grows the pointer vector as needed to accommodate
        the new element, unless the grow_size parameter passed into the
-       cl_ptr_vector_init function was zero.
+       cl_ptr_vector_init function was zero.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_remove, cl_ptr_vector_set
+
       Pointer Vector, cl_ptr_vector_remove, cl_ptr_vector_set
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_remove

[top][index]

@@ -636,12 +636,12 @@ Component Library: Pointer Vector/cl_ptr_vector_remove

SYNOPSIS

CL_EXPORT void* CL_API
 cl_ptr_vector_remove(
-        IN      cl_ptr_vector_t* const  p_vector,
+        IN      cl_ptr_vector_t* const  p_vector,
         IN      const size_t                    index );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure from which to get an
+               [in] Pointer to a cl_ptr_vector_t structure from which to get an
                element.
 
        index
@@ -651,17 +651,17 @@ Component Library: Pointer Vector/cl_ptr_vector_remove
 
       Value of the pointer stored at the specified index.
 

NOTES

-
       cl_ptr_vector_get does not perform boundary checking. Callers are
+
       cl_ptr_vector_get does not perform boundary checking. Callers are
        responsible for providing an index that is within the range of the pointer
        vector.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_insert, cl_ptr_vector_get_size
+
       Pointer Vector, cl_ptr_vector_insert, cl_ptr_vector_get_size
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_set

[top][index]

@@ -672,15 +672,15 @@ Component Library: Pointer Vector/cl_ptr_vector_set

       The cl_ptr_vector_set function sets the element at the specified index.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_ptr_vector_set(
-        IN      cl_ptr_vector_t* const  p_vector,
+        IN      cl_ptr_vector_t* const  p_vector,
         IN      const size_t                    index,
         IN      const void* const               element );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure into which to store
+               [in] Pointer to a cl_ptr_vector_t structure into which to store
                an element.
 
        index
@@ -698,15 +698,15 @@ Component Library: Pointer Vector/cl_ptr_vector_set
 

NOTES

       cl_ptr_vector_set grows the pointer vector as needed to accommodate
        the new element, unless the grow_size parameter passed into the
-       cl_ptr_vector_init function was zero.
+       cl_ptr_vector_init function was zero.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_get
+
       Pointer Vector, cl_ptr_vector_get
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_set_capacity

[top][index]

@@ -718,14 +718,14 @@ Component Library: Pointer Vector/cl_ptr_vector_set_capacity

pointer vector for a specified number of pointers.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_ptr_vector_set_capacity(
-        IN      cl_ptr_vector_t* const  p_vector,
+        IN      cl_ptr_vector_t* const  p_vector,
         IN      const size_t                    new_capacity );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure whose capacity to set.
+               [in] Pointer to a cl_ptr_vector_t structure whose capacity to set.
 
        new_capacity
                [in] Total number of elements for which the pointer vector should
@@ -744,13 +744,13 @@ Component Library: Pointer Vector/cl_ptr_vector_set_capacity
        unchanged.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_get_capacity, cl_ptr_vector_set_size,
-       cl_ptr_vector_set_min_size
+
       Pointer Vector, cl_ptr_vector_get_capacity, cl_ptr_vector_set_size,
+       cl_ptr_vector_set_min_size
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_set_min_size

[top][index]

@@ -762,14 +762,14 @@ Component Library: Pointer Vector/cl_ptr_vector_set_min_size

specified size if the pointer vector is smaller than the specified size.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_ptr_vector_set_min_size(
-        IN      cl_ptr_vector_t* const  p_vector,
+        IN      cl_ptr_vector_t* const  p_vector,
         IN      const size_t                    min_size );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure whose minimum size to set.
+               [in] Pointer to a cl_ptr_vector_t structure whose minimum size to set.
 
        min_size
                [in] Minimum number of elements that the pointer vector should contain.
@@ -789,13 +789,13 @@ Component Library: Pointer Vector/cl_ptr_vector_set_min_size
        perform the operation.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_get_size, cl_ptr_vector_set_size,
-       cl_ptr_vector_set_capacity
+
       Pointer Vector, cl_ptr_vector_get_size, cl_ptr_vector_set_size,
+       cl_ptr_vector_set_capacity
 

-

[Functions] +

[Functions] Component Library: Pointer Vector/cl_ptr_vector_set_size

[top][index]

@@ -807,14 +807,14 @@ Component Library: Pointer Vector/cl_ptr_vector_set_size

increasing or decreasing its size.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_ptr_vector_set_size(
-        IN      cl_ptr_vector_t* const  p_vector,
+        IN      cl_ptr_vector_t* const  p_vector,
         IN      const size_t                    size );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_ptr_vector_t structure whose size to set.
+               [in] Pointer to a cl_ptr_vector_t structure whose size to set.
 
        size
                [in] Number of elements desired in the pointer vector.
@@ -833,13 +833,13 @@ Component Library: Pointer Vector/cl_ptr_vector_set_size
        This function can only fail if size is larger than the current capacity.
 

SEE ALSO

-
       Pointer Vector, cl_ptr_vector_get_size, cl_ptr_vector_set_min_size,
-       cl_ptr_vector_set_capacity
+
       Pointer Vector, cl_ptr_vector_get_size, cl_ptr_vector_set_min_size,
+       cl_ptr_vector_set_capacity
 

-

[Structures] +

[Structures] Component Library: Pointer Vector/cl_ptr_vector_t

[top][index]

@@ -874,7 +874,7 @@ Component Library: Pointer Vector/cl_ptr_vector_t

total # of elements allocated. alloc_list - List of allocations. + List of allocations. p_ptr_array Internal array of pointers to elements. diff --git a/trunk/docs/complib/cl_qcomppool_h.html b/trunk/docs/complib/cl_qcomppool_h.html index 6ddfd612..20db9f23 100644 --- a/trunk/docs/complib/cl_qcomppool_h.html +++ b/trunk/docs/complib/cl_qcomppool_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_qcomppool_h.html +./inc_docs/complib/cl_qcomppool_h.html -Generated from ./inc/complib/cl_qcomppool.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_qcomppool.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Quick Composite Pool

-

[top][index]

+

[top][parent][index]

NAME

       Quick Composite Pool
 
@@ -36,35 +36,35 @@ Component Library/Quick Composite Pool returns objects to the pool. The only method of returning memory to the system is to destroy the pool. - The Quick Composite Pool operates on cl_pool_item_t structures that + The Quick Composite Pool operates on cl_pool_item_t structures that describe composite objects. This provides for more efficient memory use. - If using a cl_pool_item_t is not desired, the Composite Pool provides + If using a cl_pool_item_t is not desired, the Composite Pool provides similar functionality but operates on opaque objects. - The Quick Composit Pool functions operate on a cl_qcpool_t structure + The Quick Composit Pool functions operate on a cl_qcpool_t structure which should be treated as opaque and should be manipulated only through the provided functions.

SEE ALSO

       Structures:
-               cl_qcpool_t, cl_pool_item_t
+               cl_qcpool_t, cl_pool_item_t
 
        Callbacks:
-               cl_pfn_qcpool_init_t, cl_pfn_qcpool_dtor_t
+               cl_pfn_qcpool_init_t, cl_pfn_qcpool_dtor_t
 
        Initialization/Destruction:
-               cl_qcpool_construct, cl_qcpool_init, cl_qcpool_destroy
+               cl_qcpool_construct, cl_qcpool_init, cl_qcpool_destroy
 
        Manipulation:
-               cl_qcpool_get, cl_qcpool_put, cl_qcpool_put_list, cl_qcpool_grow
+               cl_qcpool_get, cl_qcpool_put, cl_qcpool_put_list, cl_qcpool_grow
 
        Attributes:
-               cl_is_qcpool_inited, cl_qcpool_count
+               cl_is_qcpool_inited, cl_qcpool_count
 

-

[Functions] +

[Functions] Component Library: Quick Composite Pool/cl_is_qcpool_inited

[top][index]

@@ -78,19 +78,19 @@ Component Library: Quick Composite Pool/cl_is_qcpool_inited

SYNOPSIS

CL_INLINE uint32_t CL_API
 cl_is_qcpool_inited(
-        IN      const cl_qcpool_t* const        p_pool )
+        IN      const cl_qcpool_t* const        p_pool )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_pool );
         /* CL_ASSERT that the pool is not in some invalid state. */
-        CL_ASSERT( cl_is_state_valid( p_pool->state ) );
+        CL_ASSERT( cl_is_state_valid( p_pool->state ) );
 
         return( p_pool->state == CL_INITIALIZED );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qcpool_t structure to check.
+               [in] Pointer to a cl_qcpool_t structure to check.
 
  RETURN VALUES
        TRUE if the quick composite pool was initialized successfully.
@@ -107,7 +107,7 @@ Component Library: Quick Composite Pool/cl_is_qcpool_inited
 
 
-

[Definitions] +

[Definitions] Component Library: Quick Composite Pool/cl_pfn_qcpool_dtor_t

[top][index]

@@ -122,15 +122,15 @@ Component Library: Quick Composite Pool/cl_pfn_qcpool_dtor_t

SYNOPSIS

typedef void
 (CL_API *cl_pfn_qcpool_dtor_t)(
-        IN      const cl_pool_item_t* const     p_pool_item,
+        IN      const cl_pool_item_t* const     p_pool_item,
         IN      void*                                           context );
 

PARAMETERS

       p_pool_item
-               [in] Pointer to a cl_pool_item_t structure representing an object.
+               [in] Pointer to a cl_pool_item_t structure representing an object.
 
        context
-               [in] Context provided in a call to cl_qcpool_init.
+               [in] Context provided in a call to cl_qcpool_init.
 

RETURN VALUE

       This function does not return a value.
@@ -138,7 +138,7 @@ Component Library: Quick Composite Pool/cl_pfn_qcpool_dtor_t
 

NOTES

       This function type is provided as function prototype reference for
        the function provided by the user as an optional parameter to the
-       cl_qcpool_init function.
+       cl_qcpool_init function.
 
        The destructor is invoked once per allocated object, allowing the user
        to perform any necessary cleanup. Users should not attempt to deallocate
@@ -146,12 +146,12 @@ Component Library: Quick Composite Pool/cl_pfn_qcpool_dtor_t
        object allocation and deallocation.
 

SEE ALSO

-
       Quick Composite Pool, cl_qcpool_init
+
       Quick Composite Pool, cl_qcpool_init
 

-

[Definitions] +

[Definitions] Component Library: Quick Composite Pool/cl_pfn_qcpool_init_t

[top][index]

@@ -164,12 +164,12 @@ Component Library: Quick Composite Pool/cl_pfn_qcpool_init_t

quick composite pool.

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_qcpool_init_t)(
         IN      void** const                    p_comp_array,
         IN      const uint32_t                  num_components,
         IN      void*                                   context,
-        OUT     cl_pool_item_t** const  pp_pool_item );
+        OUT     cl_pool_item_t** const  pp_pool_item );
 

PARAMETERS

       p_comp_array
@@ -180,10 +180,10 @@ Component Library: Quick Composite Pool/cl_pfn_qcpool_init_t
                [in] Number of components that in the component array.
 
        context
-               [in] Context provided in a call to cl_qcpool_init.
+               [in] Context provided in a call to cl_qcpool_init.
 
        pp_pool_item
-               [out] Users should set this pointer to reference the cl_pool_item_t
+               [out] Users should set this pointer to reference the cl_pool_item_t
                structure that represents the composite object.  This pointer must
                not be NULL if the function returns CL_SUCCESS.
 
@@ -191,39 +191,39 @@ Component Library: Quick Composite Pool/cl_pfn_qcpool_init_t
       Return CL_SUCCESS to indicate that initialization of the object
        was successful and that initialization of further objects may continue.
 
-       Other cl_status_t values will be returned by cl_qcpool_init
-       and cl_qcpool_grow.
+       Other cl_status_t values will be returned by cl_qcpool_init
+       and cl_qcpool_grow.
 

NOTES

       This function type is provided as function prototype reference for
        the function provided by the user as a parameter to the
-       cl_qcpool_init function.
+       cl_qcpool_init function.
 
        The initializer is invoked once per allocated object, allowing the user
        to chain components to form a composite object and perform any necessary
        initialization.  Returning a status other than CL_SUCCESS aborts a grow
-       operation, initiated either through cl_qcpool_init or cl_qcpool_grow,
+       operation, initiated either through cl_qcpool_init or cl_qcpool_grow,
        and causes the initiating function to fail.  Any non-CL_SUCCESS status
        will be returned by the function that initiated the grow operation.
 
        All memory for the requested number of components is pre-allocated.  Users
-       should include space in one of their components for the cl_pool_item_t
+       should include space in one of their components for the cl_pool_item_t
        structure that will represent the composite object to avoid having to
        allocate that structure in the initialization callback.  Alternatively,
-       users may specify an additional component for the cl_pool_item_t structure.
+       users may specify an additional component for the cl_pool_item_t structure.
 
-       When later performing a cl_qcpool_get call, the return value is a pointer
-       to the cl_pool_item_t returned by this function in the pp_pool_item
+       When later performing a cl_qcpool_get call, the return value is a pointer
+       to the cl_pool_item_t returned by this function in the pp_pool_item
        parameter. Users must set pp_pool_item to a valid pointer to the
-       cl_pool_item_t representing the object if they return CL_SUCCESS.
+       cl_pool_item_t representing the object if they return CL_SUCCESS.
 

SEE ALSO

-
       Quick Composite Pool, cl_qcpool_init
+
       Quick Composite Pool, cl_qcpool_init
 

-

[Structures] +

[Structures] Component Library: Quick Composite Pool/cl_pool_item_t

[top][index]

@@ -236,7 +236,7 @@ Component Library: Quick Composite Pool/cl_pool_item_t

SYNOPSIS

typedef struct _cl_pool_item
 {
-        cl_list_item_t          list_item;
+        cl_list_item_t          list_item;
 #ifdef _DEBUG_
         /* Pad to make the cl_pool_obj structure line up properly */
         void                            *pad;
@@ -259,12 +259,12 @@ Component Library: Quick Composite Pool/cl_pool_item_t
        retrieved from a quick pool in a quick list.
 

SEE ALSO

-
       Quick Composite Pool, cl_list_item_t
+
       Quick Composite Pool, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick Composite Pool/cl_qcpool_construct

[top][index]

@@ -277,29 +277,29 @@ Component Library: Quick Composite Pool/cl_qcpool_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_qcpool_construct(
-        IN      cl_qcpool_t* const      p_pool );
+        IN      cl_qcpool_t* const      p_pool );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qcpool_t structure whose state to initialize.
+               [in] Pointer to a cl_qcpool_t structure whose state to initialize.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       Allows calling cl_qcpool_init, cl_qcpool_destroy, cl_is_qcpool_inited.
+
       Allows calling cl_qcpool_init, cl_qcpool_destroy, cl_is_qcpool_inited.
 
        Calling cl_qcpool_construct is a prerequisite to calling any other
-       quick composite pool function except cl_qcpool_init.
+       quick composite pool function except cl_qcpool_init.
 

SEE ALSO

-
       Quick Composite Pool, cl_qcpool_init, cl_qcpool_destroy,
-       cl_is_qcpool_inited
+
       Quick Composite Pool, cl_qcpool_init, cl_qcpool_destroy,
+       cl_is_qcpool_inited
 

-

[Functions] +

[Functions] Component Library: Quick Composite Pool/cl_qcpool_count

[top][index]

@@ -313,17 +313,17 @@ Component Library: Quick Composite Pool/cl_qcpool_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_qcpool_count(
-        IN      cl_qcpool_t* const      p_pool )
+        IN      cl_qcpool_t* const      p_pool )
 {
         CL_ASSERT( p_pool );
         CL_ASSERT( p_pool->state == CL_INITIALIZED );
 
-        return( cl_qlist_count( &p_pool->free_list ) );
+        return( cl_qlist_count( &p_pool->free_list ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qcpool_t structure for which the number of
+               [in] Pointer to a cl_qcpool_t structure for which the number of
                available objects is requested.
 

RETURN VALUE

@@ -336,7 +336,7 @@ Component Library: Quick Composite Pool/cl_qcpool_count
-

[Functions] +

[Functions] Component Library: Quick Composite Pool/cl_qcpool_destroy

[top][index]

@@ -349,11 +349,11 @@ Component Library: Quick Composite Pool/cl_qcpool_destroy

SYNOPSIS

CL_EXPORT void CL_API
 cl_qcpool_destroy(
-        IN      cl_qcpool_t* const      p_pool );
+        IN      cl_qcpool_t* const      p_pool );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qcpool_t structure to destroy.
+               [in] Pointer to a cl_qcpool_t structure to destroy.
 

RETURN VALUE

       This function does not return a value.
@@ -365,18 +365,18 @@ Component Library: Quick Composite Pool/cl_qcpool_destroy
        cl_qcpool_destroy is invoked.
 
        This function should only be called after a call to
-       cl_qcpool_construct or cl_qcpool_init.
+       cl_qcpool_construct or cl_qcpool_init.
 
        In a debug build, cl_qcpool_destroy asserts that all objects are in
        the pool.
 

SEE ALSO

-
       Quick Composite Pool, cl_qcpool_construct, cl_qcpool_init
+
       Quick Composite Pool, cl_qcpool_construct, cl_qcpool_init
 

-

[Functions] +

[Functions] Component Library: Quick Composite Pool/cl_qcpool_get

[top][index]

@@ -388,33 +388,33 @@ Component Library: Quick Composite Pool/cl_qcpool_get

quick composite pool.

SYNOPSIS

-
CL_EXPORT cl_pool_item_t* CL_API
+
CL_EXPORT cl_pool_item_t* CL_API
 cl_qcpool_get(
-        IN      cl_qcpool_t* const      p_pool );
+        IN      cl_qcpool_t* const      p_pool );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qcpool_t structure from which to retrieve
+               [in] Pointer to a cl_qcpool_t structure from which to retrieve
                an object.
 
  RETURN VALUES
-       Returns a pointer to a cl_pool_item_t for a composite object.
+       Returns a pointer to a cl_pool_item_t for a composite object.
 
        Returns NULL if the pool is empty and can not be grown automatically.
 

NOTES

       cl_qcpool_get returns the object at the head of the pool. If the pool is
        empty, it is automatically grown to accommodate this request unless the
-       grow_size parameter passed to the cl_qcpool_init function was zero.
+       grow_size parameter passed to the cl_qcpool_init function was zero.
 

SEE ALSO

-
       Quick Composite Pool, cl_qcpool_get_tail, cl_qcpool_put,
-       cl_qcpool_grow, cl_qcpool_count
+
       Quick Composite Pool, cl_qcpool_get_tail, cl_qcpool_put,
+       cl_qcpool_grow, cl_qcpool_count
 

-

[Functions] +

[Functions] Component Library: Quick Composite Pool/cl_qcpool_grow

[top][index]

@@ -426,14 +426,14 @@ Component Library: Quick Composite Pool/cl_qcpool_grow

the specified number of objects.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_qcpool_grow(
-        IN      cl_qcpool_t* const              p_pool,
+        IN      cl_qcpool_t* const              p_pool,
         IN      size_t                                  obj_count );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qcpool_t structure whose capacity to grow.
+               [in] Pointer to a cl_qcpool_t structure whose capacity to grow.
 
        obj_count
                [in] Number of objects by which to grow the pool.
@@ -444,9 +444,9 @@ Component Library: Quick Composite Pool/cl_qcpool_grow
        CL_INSUFFICIENT_MEMORY if there was not enough memory to grow the
        quick composite pool.
 
-       cl_status_t value returned by optional initialization callback function
+       cl_status_t value returned by optional initialization callback function
        specified by the pfn_initializer parameter passed to the
-       cl_qcpool_init function.
+       cl_qcpool_init function.
 

NOTES

       It is not necessary to call cl_qcpool_grow if the pool is
@@ -458,7 +458,7 @@ Component Library: Quick Composite Pool/cl_qcpool_grow
 
 
-

[Functions] +

[Functions] Component Library: Quick Composite Pool/cl_qcpool_init

[top][index]

@@ -469,21 +469,21 @@ Component Library: Quick Composite Pool/cl_qcpool_init

       The cl_qcpool_init function initializes a quick composite pool for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_qcpool_init(
-        IN      cl_qcpool_t* const              p_pool,
+        IN      cl_qcpool_t* const              p_pool,
         IN      const size_t                    min_size,
         IN      const size_t                    max_size,
         IN      const size_t                    grow_size,
         IN      const size_t* const             component_sizes,
         IN      const uint32_t                  num_components,
-        IN      cl_pfn_qcpool_init_t    pfn_initializer OPTIONAL,
-        IN      cl_pfn_qcpool_dtor_t    pfn_destructor OPTIONAL,
+        IN      cl_pfn_qcpool_init_t    pfn_initializer OPTIONAL,
+        IN      cl_pfn_qcpool_dtor_t    pfn_destructor OPTIONAL,
         IN      const void* const               context );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qcpool_t structure to initialize.
+               [in] Pointer to a cl_qcpool_t structure to initialize.
 
        min_size
                [in] Minimum number of objects that the pool should support. All
@@ -510,14 +510,14 @@ Component Library: Quick Composite Pool/cl_qcpool_init
                [in] Initializer callback to invoke for every new object when growing
                the pool. This parameter may be NULL only if the objects stored in
                the quick composite pool consist of only one component. If NULL, the
-               pool assumes the cl_pool_item_t structure describing objects is
-               located at the head of each object. See the cl_pfn_qcpool_init_t
+               pool assumes the cl_pool_item_t structure describing objects is
+               located at the head of each object. See the cl_pfn_qcpool_init_t
                function type declaration for details about the callback function.
 
        pfn_destructor
                [in] Destructor callback to invoke for every object before memory for
                that object is freed. This parameter is optional and may be NULL.
-               See the cl_pfn_qcpool_dtor_t function type declaration for details
+               See the cl_pfn_qcpool_dtor_t function type declaration for details
                about the callback function.
 
        context
@@ -533,25 +533,25 @@ Component Library: Quick Composite Pool/cl_qcpool_init
        consisting of more than one component.  Also returns CL_INVALID_SETTING if
        the maximum size is non-zero and less than the minimum size.
 
-       Other cl_status_t value returned by optional initialization callback function
+       Other cl_status_t value returned by optional initialization callback function
        specified by the pfn_initializer parameter.
 
        If initialization fails, the pool is left in a destroyed state.  Callers
-       may still safely call cl_qcpool_destroy.
+       may still safely call cl_qcpool_destroy.
 

NOTES

       cl_qcpool_init initializes, and if necessary, grows the pool to
        the capacity desired.
 

SEE ALSO

-
       Quick Composite Pool, cl_qcpool_construct, cl_qcpool_destroy,
-       cl_qcpool_get, cl_qcpool_put, cl_qcpool_grow,
-       cl_qcpool_count, cl_pfn_qcpool_init_t, cl_pfn_qcpool_dtor_t
+
       Quick Composite Pool, cl_qcpool_construct, cl_qcpool_destroy,
+       cl_qcpool_get, cl_qcpool_put, cl_qcpool_grow,
+       cl_qcpool_count, cl_pfn_qcpool_init_t, cl_pfn_qcpool_dtor_t
 

-

[Functions] +

[Functions] Component Library: Quick Composite Pool/cl_qcpool_put

[top][index]

@@ -564,8 +564,8 @@ Component Library: Quick Composite Pool/cl_qcpool_put

SYNOPSIS

CL_INLINE void CL_API
 cl_qcpool_put(
-        IN      cl_qcpool_t* const              p_pool,
-        IN      cl_pool_item_t* const   p_pool_item )
+        IN      cl_qcpool_t* const              p_pool,
+        IN      cl_pool_item_t* const   p_pool_item )
 {
         CL_ASSERT( p_pool );
         CL_ASSERT( p_pool->state == CL_INITIALIZED );
@@ -574,16 +574,16 @@ Component Library: Quick Composite Pool/cl_qcpool_put
         CL_ASSERT( p_pool_item->p_pool == p_pool );
 
         /* return this lil' doggy to the pool */
-        cl_qlist_insert_head( &p_pool->free_list, &p_pool_item->list_item );
+        cl_qlist_insert_head( &p_pool->free_list, &p_pool_item->list_item );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qcpool_t structure to which to return
+               [in] Pointer to a cl_qcpool_t structure to which to return
                an object.
 
        p_pool_item
-               [in] Pointer to a cl_pool_item_t structure for the object
+               [in] Pointer to a cl_pool_item_t structure for the object
                being returned.
 

RETURN VALUE

@@ -593,15 +593,15 @@ Component Library: Quick Composite Pool/cl_qcpool_put
       cl_qcpool_put places the returned object at the head of the pool.
 
        The object specified by the p_pool_item parameter must have been
-       retrieved from the pool by a previous call to cl_qcpool_get.
+       retrieved from the pool by a previous call to cl_qcpool_get.
 

SEE ALSO

-
       Quick Composite Pool, cl_qcpool_put_tail, cl_qcpool_get
+
       Quick Composite Pool, cl_qcpool_put_tail, cl_qcpool_get
 

-

[Functions] +

[Functions] Component Library: Quick Composite Pool/cl_qcpool_put_list

[top][index]

@@ -615,11 +615,11 @@ Component Library: Quick Composite Pool/cl_qcpool_put_list

SYNOPSIS

CL_INLINE void CL_API
 cl_qcpool_put_list(
-        IN      cl_qcpool_t* const      p_pool,
-        IN      cl_qlist_t* const       p_list )
+        IN      cl_qcpool_t* const      p_pool,
+        IN      cl_qlist_t* const       p_list )
 {
 #ifdef _DEBUG_
-        cl_list_item_t  *p_item;
+        cl_list_item_t  *p_item;
 #endif
 
         CL_ASSERT( p_pool );
@@ -628,25 +628,25 @@ Component Library: Quick Composite Pool/cl_qcpool_put_list
 
 #ifdef _DEBUG_
         /* Chech that all items in the list came from this pool. */
-        p_item = cl_qlist_head( p_list );
-        while( p_item != cl_qlist_end( p_list ) )
+        p_item = cl_qlist_head( p_list );
+        while( p_item != cl_qlist_end( p_list ) )
         {
-                CL_ASSERT( ((cl_pool_item_t*)p_item)->p_pool == p_pool );
-                p_item = cl_qlist_next( p_item );
+                CL_ASSERT( ((cl_pool_item_t*)p_item)->p_pool == p_pool );
+                p_item = cl_qlist_next( p_item );
         }
 #endif
 
         /* return these lil' doggies to the pool */
-        cl_qlist_insert_list_head( &p_pool->free_list, p_list );
+        cl_qlist_insert_list_head( &p_pool->free_list, p_list );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qcpool_t structure to which to return
+               [in] Pointer to a cl_qcpool_t structure to which to return
                a list of objects.
 
        p_list
-               [in] Pointer to a cl_qlist_t structure for the list of objects
+               [in] Pointer to a cl_qlist_t structure for the list of objects
                being returned.
 

RETURN VALUE

@@ -656,15 +656,15 @@ Component Library: Quick Composite Pool/cl_qcpool_put_list
       cl_qcpool_put_list places the returned objects at the head of the pool.
 
        The objects in the list specified by the p_list parameter must have been
-       retrieved from the pool by a previous call to cl_qcpool_get.
+       retrieved from the pool by a previous call to cl_qcpool_get.
 

SEE ALSO

-
       Quick Composite Pool, cl_qcpool_put, cl_qcpool_put_tail, cl_qcpool_get
+
       Quick Composite Pool, cl_qcpool_put, cl_qcpool_put_tail, cl_qcpool_get
 

-

[Structures] +

[Structures] Component Library: Quick Composite Pool/cl_qcpool_t

[top][index]

@@ -686,11 +686,11 @@ Component Library: Quick Composite Pool/cl_qcpool_t

size_t num_objects; size_t max_objects; size_t grow_size; - cl_pfn_qcpool_init_t pfn_init; - cl_pfn_qcpool_dtor_t pfn_dtor; + cl_pfn_qcpool_init_t pfn_init; + cl_pfn_qcpool_dtor_t pfn_dtor; const void *context; - cl_qlist_t free_list; - cl_qlist_t alloc_list; + cl_qlist_t free_list; + cl_qlist_t alloc_list; cl_state_t state; } cl_qcpool_t; diff --git a/trunk/docs/complib/cl_qlist_h.html b/trunk/docs/complib/cl_qlist_h.html index fe801d43..2091f871 100644 --- a/trunk/docs/complib/cl_qlist_h.html +++ b/trunk/docs/complib/cl_qlist_h.html @@ -2,25 +2,25 @@ -./inc_doc/complib/cl_qlist_h.html +./inc_docs/complib/cl_qlist_h.html -Generated from ./inc/complib/cl_qlist.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_qlist.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Quick List

-

[top][index]

+

[top][parent][index]

NAME

-
       Quick List
+
       Quick List
 

DESCRIPTION

       Quick list implements a doubly linked that stores user provided
-       cl_list_item_t structures.
+       cl_list_item_t structures.
        Quick list does not allocate any memory, and can therefore not fail any
        operations.  Quick list can therefore be useful in minimizing the error
        paths in code.
@@ -29,47 +29,47 @@ Component Library/Quick List
        adding and removing items from the list. Note that it is possible to
        walk a quick list while simultaneously adding to it.
 
-       The Quick List functions operate on a cl_qlist_t structure which should be
+       The Quick List functions operate on a cl_qlist_t structure which should be
        treated as opaque and should be manipulated only through the provided
        functions.
 

SEE ALSO

       Structures:
-               cl_qlist_t, cl_list_item_t, cl_list_obj_t
+               cl_qlist_t, cl_list_item_t, cl_list_obj_t
 
        Callbacks:
-               cl_pfn_qlist_apply_t, cl_pfn_qlist_find_t
+               cl_pfn_qlist_apply_t, cl_pfn_qlist_find_t
 
        Item Manipulation:
-               cl_qlist_set_obj, cl_qlist_obj
+               cl_qlist_set_obj, cl_qlist_obj
 
        Initialization:
-               cl_qlist_init
+               cl_qlist_init
 
        Iteration:
-               cl_qlist_next, cl_qlist_prev, cl_qlist_head, cl_qlist_tail,
-               cl_qlist_end
+               cl_qlist_next, cl_qlist_prev, cl_qlist_head, cl_qlist_tail,
+               cl_qlist_end
 
        Manipulation:
-               cl_qlist_insert_head, cl_qlist_insert_tail,
-               cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
-               cl_qlist_insert_array_head, cl_qlist_insert_array_tail,
-               cl_qlist_insert_prev, cl_qlist_insert_next,
-               cl_qlist_remove_head, cl_qlist_remove_tail,
-               cl_qlist_remove_item, cl_qlist_remove_all
+               cl_qlist_insert_head, cl_qlist_insert_tail,
+               cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
+               cl_qlist_insert_array_head, cl_qlist_insert_array_tail,
+               cl_qlist_insert_prev, cl_qlist_insert_next,
+               cl_qlist_remove_head, cl_qlist_remove_tail,
+               cl_qlist_remove_item, cl_qlist_remove_all
 
        Search:
-               cl_is_item_in_qlist, cl_qlist_find_next, cl_qlist_find_prev,
-               cl_qlist_find_from_head, cl_qlist_find_from_tail
-               cl_qlist_apply_func, cl_qlist_move_items
+               cl_is_item_in_qlist, cl_qlist_find_next, cl_qlist_find_prev,
+               cl_qlist_find_from_head, cl_qlist_find_from_tail
+               cl_qlist_apply_func, cl_qlist_move_items
 
        Attributes:
-               cl_qlist_count, cl_is_qlist_empty
+               cl_qlist_count, cl_is_qlist_empty
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_is_item_in_qlist

[top][index]

@@ -83,15 +83,15 @@ Component Library: Quick List/cl_is_item_in_qlist

SYNOPSIS

CL_EXPORT boolean_t CL_API
 cl_is_item_in_qlist(
-        IN      const cl_qlist_t* const         p_list,
-        IN      const cl_list_item_t* const     p_list_item );
+        IN      const cl_qlist_t* const         p_list,
+        IN      const cl_list_item_t* const     p_list_item );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 
        p_list_item
-               [in] Pointer to the cl_list_item_t to find.
+               [in] Pointer to the cl_list_item_t to find.
 
  RETURN VALUES
        TRUE if the list item was found in the quick list.
@@ -99,12 +99,12 @@ Component Library: Quick List/cl_is_item_in_qlist
        FALSE otherwise.
 

SEE ALSO

-
       Quick List, cl_qlist_remove_item, cl_list_item_t
+
       Quick List, cl_qlist_remove_item, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_is_qlist_empty

[top][index]

@@ -117,19 +117,19 @@ Component Library: Quick List/cl_is_qlist_empty

SYNOPSIS

CL_INLINE boolean_t CL_API
 cl_is_qlist_empty(
-        IN      const cl_qlist_t* const p_list )
+        IN      const cl_qlist_t* const p_list )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
         /* CL_ASSERT that the list was initialized. */
         CL_ASSERT( p_list->state == CL_INITIALIZED );
 
-        return( !cl_qlist_count( p_list ) );
+        return( !cl_qlist_count( p_list ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 
  RETURN VALUES
        TRUE if the specified quick list is empty.
@@ -137,12 +137,12 @@ Component Library: Quick List/cl_is_qlist_empty
        FALSE otherwise.
 

SEE ALSO

-
       Quick List, cl_qlist_count, cl_qlist_remove_all
+
       Quick List, cl_qlist_count, cl_qlist_remove_all
 

-

[Structures] +

[Structures] Component Library: Quick List/cl_list_item_t

[top][index]

@@ -171,12 +171,12 @@ Component Library: Quick List/cl_list_item_t

Used internally by the list. Users should not use this field.

SEE ALSO

-
       Quick List
+
       Quick List
 

-

[Structures] +

[Structures] Component Library: Quick List/cl_list_obj_t

[top][index]

@@ -187,9 +187,9 @@ Component Library: Quick List/cl_list_obj_t

       The cl_list_obj_t structure is used by lists to store objects.
 

SYNOPSIS

-
typedef struct _cl_list_obj
+
typedef struct _cl_list_obj
 {
-        cl_list_item_t          list_item;
+        cl_list_item_t          list_item;
         const void                      *p_object;              /* User's context */
 
 } cl_list_obj_t;
@@ -200,20 +200,20 @@ Component Library: Quick List/cl_list_obj_t
 
        p_object
                User defined context. Users should not access this field directly.
-               Use cl_qlist_set_obj and cl_qlist_obj to set and retrieve the value
+               Use cl_qlist_set_obj and cl_qlist_obj to set and retrieve the value
                of this field.
 

NOTES

-
       Users can use the cl_qlist_set_obj and cl_qlist_obj functions to store
+
       Users can use the cl_qlist_set_obj and cl_qlist_obj functions to store
        and retrieve context information in the list item.
 

SEE ALSO

-
       Quick List, cl_qlist_set_obj, cl_qlist_obj, cl_list_item_t
+
       Quick List, cl_qlist_set_obj, cl_qlist_obj, cl_list_item_t
 

-

[Definitions] +

[Definitions] Component Library: Quick List/cl_pfn_qlist_apply_t

[top][index]

@@ -227,12 +227,12 @@ Component Library: Quick List/cl_pfn_qlist_apply_t

SYNOPSIS

typedef void
 (CL_API *cl_pfn_qlist_apply_t)(
-        IN      cl_list_item_t* const   p_list_item,
+        IN      cl_list_item_t* const   p_list_item,
         IN      void*                                   context );
 

PARAMETERS

       p_list_item
-               [in] Pointer to a cl_list_item_t structure.
+               [in] Pointer to a cl_list_item_t structure.
 
        context
                [in] Value passed to the callback function.
@@ -242,16 +242,16 @@ Component Library: Quick List/cl_pfn_qlist_apply_t
 

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_qlist_apply_func
+       function provided by users as a parameter to the cl_qlist_apply_func
        function.
 

SEE ALSO

-
       Quick List, cl_qlist_apply_func
+
       Quick List, cl_qlist_apply_func
 

-

[Definitions] +

[Definitions] Component Library: Quick List/cl_pfn_qlist_find_t

[top][index]

@@ -263,14 +263,14 @@ Component Library: Quick List/cl_pfn_qlist_find_t

used to find items in a quick list.

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_qlist_find_t)(
-        IN      const cl_list_item_t* const     p_list_item,
+        IN      const cl_list_item_t* const     p_list_item,
         IN      void*                                           context );
 

PARAMETERS

       p_list_item
-               [in] Pointer to a cl_list_item_t.
+               [in] Pointer to a cl_list_item_t.
 
        context
                [in] Value passed to the callback function.
@@ -282,18 +282,18 @@ Component Library: Quick List/cl_pfn_qlist_find_t
 

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_qlist_find_from_head,
-       cl_qlist_find_from_tail, cl_qlist_find_next, and cl_qlist_find_prev
+       function provided by users as a parameter to the cl_qlist_find_from_head,
+       cl_qlist_find_from_tail, cl_qlist_find_next, and cl_qlist_find_prev
        functions.
 

SEE ALSO

-
       Quick List, cl_qlist_find_from_head, cl_qlist_find_from_tail,
-       cl_qlist_find_next, cl_qlist_find_prev
+
       Quick List, cl_qlist_find_from_head, cl_qlist_find_from_tail,
+       cl_qlist_find_next, cl_qlist_find_prev
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_apply_func

[top][index]

@@ -307,17 +307,17 @@ Component Library: Quick List/cl_qlist_apply_func

SYNOPSIS

CL_EXPORT void CL_API
 cl_qlist_apply_func(
-        IN      const cl_qlist_t* const p_list,
-        IN      cl_pfn_qlist_apply_t    pfn_func,
+        IN      const cl_qlist_t* const p_list,
+        IN      cl_pfn_qlist_apply_t    pfn_func,
         IN      const void* const               context );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 
        pfn_func
                [in] Function invoked for every item in the quick list.
-               See the cl_pfn_qlist_apply_t function type declaration for details
+               See the cl_pfn_qlist_apply_t function type declaration for details
                about the callback function.
 
        context
@@ -331,13 +331,13 @@ Component Library: Quick List/cl_qlist_apply_func
        would corrupt the quick list.
 

SEE ALSO

-
       Quick List, cl_qlist_find_from_head, cl_qlist_find_from_tail,
-       cl_qlist_move_items, cl_pfn_qlist_apply_t
+
       Quick List, cl_qlist_find_from_head, cl_qlist_find_from_tail,
+       cl_qlist_move_items, cl_pfn_qlist_apply_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_count

[top][index]

@@ -351,7 +351,7 @@ Component Library: Quick List/cl_qlist_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_qlist_count(
-        IN      const cl_qlist_t* const p_list )
+        IN      const cl_qlist_t* const p_list )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
@@ -363,19 +363,19 @@ Component Library: Quick List/cl_qlist_count
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 

RETURN VALUE

       Number of items in the list.  This function iterates though the quick
        list to count the items.
 

SEE ALSO

-
       Quick List, cl_is_qlist_empty
+
       Quick List, cl_is_qlist_empty
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_end

[top][index]

@@ -386,9 +386,9 @@ Component Library: Quick List/cl_qlist_end

       The cl_qlist_end function returns the end of a quick list.
 

SYNOPSIS

-
CL_INLINE const cl_list_item_t* const CL_API
+
CL_INLINE const cl_list_item_t* const CL_API
 cl_qlist_end(
-        IN      const cl_qlist_t* const p_list )
+        IN      const cl_qlist_t* const p_list )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
@@ -400,27 +400,27 @@ Component Library: Quick List/cl_qlist_end
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 

RETURN VALUE

       Pointer to the end of the list.
 

NOTES

       cl_qlist_end is useful for determining the validity of list items returned
-       by cl_qlist_head, cl_qlist_tail, cl_qlist_next, cl_qlist_prev, as well as
+       by cl_qlist_head, cl_qlist_tail, cl_qlist_next, cl_qlist_prev, as well as
        the cl_qlist_find functions.  If the list item pointer returned by any of
        these functions compares to the end, the end of the list was encoutered.
-       When using cl_qlist_head or cl_qlist_tail, this condition indicates that
+       When using cl_qlist_head or cl_qlist_tail, this condition indicates that
        the list is empty.
 

SEE ALSO

-
       Quick List, cl_qlist_head, cl_qlist_tail, cl_qlist_next, cl_qlist_prev,
-       cl_list_item_t
+
       Quick List, cl_qlist_head, cl_qlist_tail, cl_qlist_next, cl_qlist_prev,
+       cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_find_from_head

[top][index]

@@ -432,10 +432,10 @@ Component Library: Quick List/cl_qlist_find_from_head

search for an item, starting at the head of a quick list.

SYNOPSIS

-
CL_INLINE cl_list_item_t* CL_API
+
CL_INLINE cl_list_item_t* CL_API
 cl_qlist_find_from_head(
-        IN      const cl_qlist_t* const p_list,
-        IN      cl_pfn_qlist_find_t             pfn_func,
+        IN      const cl_qlist_t* const p_list,
+        IN      cl_pfn_qlist_find_t             pfn_func,
         IN      const void* const               context )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
@@ -445,17 +445,17 @@ Component Library: Quick List/cl_qlist_find_from_head
         /* CL_ASSERT that a find function is provided. */
         CL_ASSERT( pfn_func );
 
-        return( cl_qlist_find_next( p_list, cl_qlist_end( p_list ), pfn_func,
+        return( cl_qlist_find_next( p_list, cl_qlist_end( p_list ), pfn_func,
                 context ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 
        pfn_func
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_qlist_find_t function type declaration for details
+               See the cl_pfn_qlist_find_t function type declaration for details
                about the callback function.
 
        context
@@ -477,14 +477,14 @@ Component Library: Quick List/cl_qlist_find_from_head
        operations, as these would corrupt the list.
 

SEE ALSO

-
       Quick List, cl_qlist_find_from_tail, cl_qlist_find_next, cl_qlist_find_prev,
-       cl_qlist_end, cl_qlist_apply_func, cl_qlist_move_items, cl_list_item_t,
-       cl_pfn_qlist_find_t
+
       Quick List, cl_qlist_find_from_tail, cl_qlist_find_next, cl_qlist_find_prev,
+       cl_qlist_end, cl_qlist_apply_func, cl_qlist_move_items, cl_list_item_t,
+       cl_pfn_qlist_find_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_find_from_tail

[top][index]

@@ -496,10 +496,10 @@ Component Library: Quick List/cl_qlist_find_from_tail

search for an item, starting at the tail of a quick list.

SYNOPSIS

-
CL_INLINE cl_list_item_t* CL_API
+
CL_INLINE cl_list_item_t* CL_API
 cl_qlist_find_from_tail(
-        IN      const cl_qlist_t* const p_list,
-        IN      cl_pfn_qlist_find_t             pfn_func,
+        IN      const cl_qlist_t* const p_list,
+        IN      cl_pfn_qlist_find_t             pfn_func,
         IN      const void* const               context )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
@@ -509,17 +509,17 @@ Component Library: Quick List/cl_qlist_find_from_tail
         /* CL_ASSERT that a find function is provided. */
         CL_ASSERT( pfn_func );
 
-        return( cl_qlist_find_prev( p_list, cl_qlist_end( p_list ), pfn_func,
+        return( cl_qlist_find_prev( p_list, cl_qlist_end( p_list ), pfn_func,
                 context ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 
        pfn_func
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_qlist_find_t function type declaration for details
+               See the cl_pfn_qlist_find_t function type declaration for details
                about the callback function.
 
        context
@@ -541,14 +541,14 @@ Component Library: Quick List/cl_qlist_find_from_tail
        operations, as these would corrupt the list.
 

SEE ALSO

-
       Quick List, cl_qlist_find_from_head, cl_qlist_find_next, cl_qlist_find_prev,
-       cl_qlist_apply_func, cl_qlist_end, cl_qlist_move_items, cl_list_item_t,
-       cl_pfn_qlist_find_t
+
       Quick List, cl_qlist_find_from_head, cl_qlist_find_next, cl_qlist_find_prev,
+       cl_qlist_apply_func, cl_qlist_end, cl_qlist_move_items, cl_list_item_t,
+       cl_pfn_qlist_find_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_find_next

[top][index]

@@ -560,23 +560,23 @@ Component Library: Quick List/cl_qlist_find_next

search for an item, starting from a given list item.

SYNOPSIS

-
CL_EXPORT cl_list_item_t* CL_API
+
CL_EXPORT cl_list_item_t* CL_API
 cl_qlist_find_next(
-        IN      const cl_qlist_t* const         p_list,
-        IN      const cl_list_item_t* const     p_list_item,
-        IN      cl_pfn_qlist_find_t                     pfn_func,
+        IN      const cl_qlist_t* const         p_list,
+        IN      const cl_list_item_t* const     p_list_item,
+        IN      cl_pfn_qlist_find_t                     pfn_func,
         IN      const void* const                       context );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure in which to search.
+               [in] Pointer to a cl_qlist_t structure in which to search.
 
        p_list_item
-               [in] Pointer to a cl_list_item_t structure from which to start the search.
+               [in] Pointer to a cl_list_item_t structure from which to start the search.
 
        pfn_func
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_qlist_find_t function type declaration for details
+               See the cl_pfn_qlist_find_t function type declaration for details
                about the callback function.
 
        context
@@ -599,14 +599,14 @@ Component Library: Quick List/cl_qlist_find_next
        as these would corrupt the list.
 

SEE ALSO

-
       Quick List, cl_qlist_find_prev, cl_qlist_find_from_head,
-       cl_qlist_find_from_tail, cl_qlist_end, cl_qlist_apply_func,
-       cl_qlist_move_items, cl_list_item_t, cl_pfn_qlist_find_t
+
       Quick List, cl_qlist_find_prev, cl_qlist_find_from_head,
+       cl_qlist_find_from_tail, cl_qlist_end, cl_qlist_apply_func,
+       cl_qlist_move_items, cl_list_item_t, cl_pfn_qlist_find_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_find_prev

[top][index]

@@ -618,23 +618,23 @@ Component Library: Quick List/cl_qlist_find_prev

search backward for an item, starting from a given list item.

SYNOPSIS

-
CL_EXPORT cl_list_item_t* CL_API
+
CL_EXPORT cl_list_item_t* CL_API
 cl_qlist_find_prev(
-        IN      const cl_qlist_t* const         p_list,
-        IN      const cl_list_item_t* const     p_list_item,
-        IN      cl_pfn_qlist_find_t                     pfn_func,
+        IN      const cl_qlist_t* const         p_list,
+        IN      const cl_list_item_t* const     p_list_item,
+        IN      cl_pfn_qlist_find_t                     pfn_func,
         IN      const void* const                       context );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure in which to search.
+               [in] Pointer to a cl_qlist_t structure in which to search.
 
        p_list_item
-               [in] Pointer to a cl_list_item_t structure from which to start the search.
+               [in] Pointer to a cl_list_item_t structure from which to start the search.
 
        pfn_func
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_qlist_find_t function type declaration for details
+               See the cl_pfn_qlist_find_t function type declaration for details
                about the callback function.
 
        context
@@ -657,14 +657,14 @@ Component Library: Quick List/cl_qlist_find_prev
        as these would corrupt the list.
 

SEE ALSO

-
       Quick List, cl_qlist_find_next, cl_qlist_find_from_head,
-       cl_qlist_find_from_tail, cl_qlist_end, cl_qlist_apply_func,
-       cl_qlist_move_items, cl_list_item_t, cl_pfn_qlist_find_t
+
       Quick List, cl_qlist_find_next, cl_qlist_find_from_head,
+       cl_qlist_find_from_tail, cl_qlist_end, cl_qlist_apply_func,
+       cl_qlist_move_items, cl_list_item_t, cl_pfn_qlist_find_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_head

[top][index]

@@ -676,21 +676,21 @@ Component Library: Quick List/cl_qlist_head

the head of a quick list.

SYNOPSIS

-
CL_INLINE cl_list_item_t* CL_API
+
CL_INLINE cl_list_item_t* CL_API
 cl_qlist_head(
-        IN      const cl_qlist_t* const p_list )
+        IN      const cl_qlist_t* const p_list )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
         /* CL_ASSERT that the list was initialized. */
         CL_ASSERT( p_list->state == CL_INITIALIZED );
 
-        return( cl_qlist_next( &p_list->end ) );
+        return( cl_qlist_next( &p_list->end ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 
  RETURN VALUES
        Pointer to the list item at the head of the quick list.
@@ -701,13 +701,13 @@ Component Library: Quick List/cl_qlist_head
 
       cl_qlist_head does not remove the item from the list.
 

SEE ALSO

-
       Quick List, cl_qlist_tail, cl_qlist_next, cl_qlist_prev, cl_qlist_end,
-       cl_list_item_t
+
       Quick List, cl_qlist_tail, cl_qlist_next, cl_qlist_prev, cl_qlist_end,
+       cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_init

[top][index]

@@ -720,7 +720,7 @@ Component Library: Quick List/cl_qlist_init

SYNOPSIS

CL_INLINE void CL_API
 cl_qlist_init(
-        IN      cl_qlist_t* const       p_list )
+        IN      cl_qlist_t* const       p_list )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
@@ -733,7 +733,7 @@ Component Library: Quick List/cl_qlist_init
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure to initialize.
+               [in] Pointer to a cl_qlist_t structure to initialize.
 
  RETURN VALUES
        This function does not return a value.
@@ -742,13 +742,13 @@ Component Library: Quick List/cl_qlist_init
 
       Allows calling quick list manipulation functions.
 

SEE ALSO

-
       Quick List, cl_qlist_insert_head, cl_qlist_insert_tail,
-       cl_qlist_remove_head, cl_qlist_remove_tail
+
       Quick List, cl_qlist_insert_head, cl_qlist_insert_tail,
+       cl_qlist_remove_head, cl_qlist_remove_tail
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_insert_array_head

[top][index]

@@ -762,26 +762,26 @@ Component Library: Quick List/cl_qlist_insert_array_head

SYNOPSIS

CL_EXPORT void CL_API
 cl_qlist_insert_array_head(
-        IN      cl_qlist_t* const               p_list,
-        IN      cl_list_item_t* const   p_array,
+        IN      cl_qlist_t* const               p_list,
+        IN      cl_list_item_t* const   p_array,
         IN      size_t                                  item_count,
         IN      const size_t                    item_size );
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure into which to insert
+               [in] Pointer to a cl_qlist_t structure into which to insert
                the objects.
 
        p_array
-               [in] Pointer to the first list item in an array of cl_list_item_t
+               [in] Pointer to the first list item in an array of cl_list_item_t
                structures.
 
        item_count
-               [in] Number of cl_list_item_t structures in the array.
+               [in] Number of cl_list_item_t structures in the array.
 
        item_size
                [in] Size of the items added to the list. This is the stride in the
-               array from one cl_list_item_t structure to the next.
+               array from one cl_list_item_t structure to the next.
 

RETURN VALUE

       This function does not return a value.
@@ -791,19 +791,19 @@ Component Library: Quick List/cl_qlist_insert_array_head
        to the head of the quick list specified by the p_list parameter,
        preserving ordering of the list items.
 
-       The array pointer passed into the function points to the cl_list_item_t
+       The array pointer passed into the function points to the cl_list_item_t
        in the first element of the caller's element array.  There is no
        restriction on where the element is stored in the parent structure.
 

SEE ALSO

-
       Quick List, cl_qlist_insert_array_tail, cl_qlist_insert_head,
-       cl_qlist_insert_tail, cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
-       cl_qlist_insert_prev, cl_qlist_insert_next, cl_list_item_t
+
       Quick List, cl_qlist_insert_array_tail, cl_qlist_insert_head,
+       cl_qlist_insert_tail, cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
+       cl_qlist_insert_prev, cl_qlist_insert_next, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_insert_array_tail

[top][index]

@@ -817,26 +817,26 @@ Component Library: Quick List/cl_qlist_insert_array_tail

SYNOPSIS

CL_EXPORT void CL_API
 cl_qlist_insert_array_tail(
-        IN      cl_qlist_t* const               p_list,
-        IN      cl_list_item_t* const   p_array,
+        IN      cl_qlist_t* const               p_list,
+        IN      cl_list_item_t* const   p_array,
         IN      size_t                                  item_count,
         IN      const size_t                    item_size);
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure into which to insert
+               [in] Pointer to a cl_qlist_t structure into which to insert
                the objects.
 
        p_array
-               [in] Pointer to the first list item in an array of cl_list_item_t
+               [in] Pointer to the first list item in an array of cl_list_item_t
                structures.
 
        item_count
-               [in] Number of cl_list_item_t structures in the array.
+               [in] Number of cl_list_item_t structures in the array.
 
        item_size
                [in] Size of the items added to the list. This is the stride in the
-               array from one cl_list_item_t structure to the next.
+               array from one cl_list_item_t structure to the next.
 

RETURN VALUE

       This function does not return a value.
@@ -846,19 +846,19 @@ Component Library: Quick List/cl_qlist_insert_array_tail
        to the tail of the quick list specified by the p_list parameter,
        preserving ordering of the list items.
 
-       The array pointer passed into the function points to the cl_list_item_t
+       The array pointer passed into the function points to the cl_list_item_t
        in the first element of the caller's element array.  There is no
        restriction on where the element is stored in the parent structure.
 

SEE ALSO

-
       Quick List, cl_qlist_insert_array_head, cl_qlist_insert_head,
-       cl_qlist_insert_tail, cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
-       cl_qlist_insert_prev, cl_qlist_insert_next, cl_list_item_t
+
       Quick List, cl_qlist_insert_array_head, cl_qlist_insert_head,
+       cl_qlist_insert_tail, cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
+       cl_qlist_insert_prev, cl_qlist_insert_next, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_insert_head

[top][index]

@@ -872,8 +872,8 @@ Component Library: Quick List/cl_qlist_insert_head

SYNOPSIS

CL_INLINE void CL_API
 cl_qlist_insert_head(
-        IN      cl_qlist_t* const               p_list,
-        IN      cl_list_item_t* const   p_list_item )
+        IN      cl_qlist_t* const               p_list,
+        IN      cl_list_item_t* const   p_list_item )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
@@ -895,17 +895,17 @@ Component Library: Quick List/cl_qlist_insert_head
 #endif
 
         /* Insert before the head. */
-        __cl_primitive_insert( cl_qlist_head( p_list ), p_list_item );
+        __cl_primitive_insert( cl_qlist_head( p_list ), p_list_item );
 
         p_list->count++;
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure into which to insert the object.
+               [in] Pointer to a cl_qlist_t structure into which to insert the object.
 
        p_list_item
-               [in] Pointer to a cl_list_item_t structure to add.
+               [in] Pointer to a cl_list_item_t structure to add.
 

RETURN VALUE

       This function does not return a value.
@@ -915,15 +915,15 @@ Component Library: Quick List/cl_qlist_insert_head
        is not already in the list.
 

SEE ALSO

-
       Quick List, cl_qlist_insert_tail, cl_qlist_insert_list_head,
-       cl_qlist_insert_list_tail, cl_qlist_insert_array_head,
-       cl_qlist_insert_array_tail, cl_qlist_insert_prev, cl_qlist_insert_next,
-       cl_qlist_remove_head, cl_list_item_t
+
       Quick List, cl_qlist_insert_tail, cl_qlist_insert_list_head,
+       cl_qlist_insert_list_tail, cl_qlist_insert_array_head,
+       cl_qlist_insert_array_tail, cl_qlist_insert_prev, cl_qlist_insert_next,
+       cl_qlist_remove_head, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_insert_list_head

[top][index]

@@ -937,8 +937,8 @@ Component Library: Quick List/cl_qlist_insert_list_head

SYNOPSIS

CL_EXPORT void CL_API
 cl_qlist_insert_list_head(
-        IN      cl_qlist_t* const       p_dest_list,
-        IN      cl_qlist_t* const       p_src_list );
+        IN      cl_qlist_t* const       p_dest_list,
+        IN      cl_qlist_t* const       p_src_list );
 

PARAMETERS

       p_dest_list
@@ -958,15 +958,15 @@ Component Library: Quick List/cl_qlist_insert_list_head
        the call returns.
 

SEE ALSO

-
       Quick List, cl_qlist_insert_list_tail, cl_qlist_insert_head,
-       cl_qlist_insert_tail, cl_qlist_insert_array_head,
-       cl_qlist_insert_array_tail, cl_qlist_insert_prev, cl_qlist_insert_next,
-       cl_list_item_t
+
       Quick List, cl_qlist_insert_list_tail, cl_qlist_insert_head,
+       cl_qlist_insert_tail, cl_qlist_insert_array_head,
+       cl_qlist_insert_array_tail, cl_qlist_insert_prev, cl_qlist_insert_next,
+       cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_insert_list_tail

[top][index]

@@ -980,8 +980,8 @@ Component Library: Quick List/cl_qlist_insert_list_tail

SYNOPSIS

CL_EXPORT void CL_API
 cl_qlist_insert_list_tail(
-        IN      cl_qlist_t* const       p_dest_list,
-        IN      cl_qlist_t* const       p_src_list );
+        IN      cl_qlist_t* const       p_dest_list,
+        IN      cl_qlist_t* const       p_src_list );
 

PARAMETERS

       p_dest_list
@@ -1001,15 +1001,15 @@ Component Library: Quick List/cl_qlist_insert_list_tail
        the call returns.
 

SEE ALSO

-
       Quick List, cl_qlist_insert_list_head, cl_qlist_insert_head,
-       cl_qlist_insert_tail, cl_qlist_insert_array_head,
-       cl_qlist_insert_array_tail, cl_qlist_insert_prev, cl_qlist_insert_next,
-       cl_list_item_t
+
       Quick List, cl_qlist_insert_list_head, cl_qlist_insert_head,
+       cl_qlist_insert_tail, cl_qlist_insert_array_head,
+       cl_qlist_insert_array_tail, cl_qlist_insert_prev, cl_qlist_insert_next,
+       cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_insert_next

[top][index]

@@ -1023,9 +1023,9 @@ Component Library: Quick List/cl_qlist_insert_next

SYNOPSIS

CL_INLINE void CL_API
 cl_qlist_insert_next(
-        IN      cl_qlist_t* const               p_list,
-        IN      cl_list_item_t* const   p_list_item,
-        IN      cl_list_item_t* const   p_new_item )
+        IN      cl_qlist_t* const               p_list,
+        IN      cl_list_item_t* const   p_list_item,
+        IN      cl_list_item_t* const   p_new_item )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
@@ -1048,20 +1048,20 @@ Component Library: Quick List/cl_qlist_insert_next
         p_new_item->p_list = p_list;
 #endif
 
-        __cl_primitive_insert( cl_qlist_next( p_list_item ), p_new_item );
+        __cl_primitive_insert( cl_qlist_next( p_list_item ), p_new_item );
 
         p_list->count++;
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure into which to add the new item.
+               [in] Pointer to a cl_qlist_t structure into which to add the new item.
 
        p_list_item
-               [in] Pointer to a cl_list_item_t structure.
+               [in] Pointer to a cl_list_item_t structure.
 
        p_new_item
-               [in] Pointer to a cl_list_item_t structure to add to the quick list.
+               [in] Pointer to a cl_list_item_t structure to add to the quick list.
 

RETURN VALUE

       This function does not return a value.
@@ -1071,14 +1071,14 @@ Component Library: Quick List/cl_qlist_insert_next
        The list item specified by p_list_item must be in the quick list.
 

SEE ALSO

-
       Quick List, cl_qlist_insert_prev, cl_qlist_insert_head,
-       cl_qlist_insert_tail, cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
-       cl_qlist_insert_array_head, cl_qlist_insert_array_tail, cl_list_item_t
+
       Quick List, cl_qlist_insert_prev, cl_qlist_insert_head,
+       cl_qlist_insert_tail, cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
+       cl_qlist_insert_array_head, cl_qlist_insert_array_tail, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_insert_prev

[top][index]

@@ -1092,9 +1092,9 @@ Component Library: Quick List/cl_qlist_insert_prev

SYNOPSIS

CL_INLINE void CL_API
 cl_qlist_insert_prev(
-        IN      cl_qlist_t* const               p_list,
-        IN      cl_list_item_t* const   p_list_item,
-        IN      cl_list_item_t* const   p_new_item )
+        IN      cl_qlist_t* const               p_list,
+        IN      cl_list_item_t* const   p_list_item,
+        IN      cl_list_item_t* const   p_new_item )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
@@ -1124,13 +1124,13 @@ Component Library: Quick List/cl_qlist_insert_prev
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure into which to add the new item.
+               [in] Pointer to a cl_qlist_t structure into which to add the new item.
 
        p_list_item
-               [in] Pointer to a cl_list_item_t structure.
+               [in] Pointer to a cl_list_item_t structure.
 
        p_new_item
-               [in] Pointer to a cl_list_item_t structure to add to the quick list.
+               [in] Pointer to a cl_list_item_t structure to add to the quick list.
 

RETURN VALUE

       This function does not return a value.
@@ -1139,14 +1139,14 @@ Component Library: Quick List/cl_qlist_insert_prev
 
       Inserts the new list item before the list item specified by p_list_item.
 

SEE ALSO

-
       Quick List, cl_qlist_insert_next, cl_qlist_insert_head,
-       cl_qlist_insert_tail, cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
-       cl_qlist_insert_array_head, cl_qlist_insert_array_tail, cl_list_item_t
+
       Quick List, cl_qlist_insert_next, cl_qlist_insert_head,
+       cl_qlist_insert_tail, cl_qlist_insert_list_head, cl_qlist_insert_list_tail,
+       cl_qlist_insert_array_head, cl_qlist_insert_array_tail, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_insert_tail

[top][index]

@@ -1160,8 +1160,8 @@ Component Library: Quick List/cl_qlist_insert_tail

SYNOPSIS

CL_INLINE void CL_API
 cl_qlist_insert_tail(
-        IN      cl_qlist_t* const               p_list,
-        IN      cl_list_item_t* const   p_list_item )
+        IN      cl_qlist_t* const               p_list,
+        IN      cl_list_item_t* const   p_list_item )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
@@ -1193,10 +1193,10 @@ Component Library: Quick List/cl_qlist_insert_tail
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure into which to insert the object.
+               [in] Pointer to a cl_qlist_t structure into which to insert the object.
 
        p_list_item
-               [in] Pointer to cl_list_item_t structure to add.
+               [in] Pointer to cl_list_item_t structure to add.
 

RETURN VALUE

       This function does not return a value.
@@ -1206,15 +1206,15 @@ Component Library: Quick List/cl_qlist_insert_tail
        is not already in the list.
 

SEE ALSO

-
       Quick List, cl_qlist_insert_head, cl_qlist_insert_list_head,
-       cl_qlist_insert_list_tail, cl_qlist_insert_array_head,
-       cl_qlist_insert_array_tail, cl_qlist_insert_prev, cl_qlist_insert_next,
-       cl_qlist_remove_tail, cl_list_item_t
+
       Quick List, cl_qlist_insert_head, cl_qlist_insert_list_head,
+       cl_qlist_insert_list_tail, cl_qlist_insert_array_head,
+       cl_qlist_insert_array_tail, cl_qlist_insert_prev, cl_qlist_insert_next,
+       cl_qlist_remove_tail, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_move_items

[top][index]

@@ -1228,23 +1228,23 @@ Component Library: Quick List/cl_qlist_move_items

SYNOPSIS

CL_EXPORT void CL_API
 cl_qlist_move_items(
-        IN      cl_qlist_t* const       p_src_list,
-        IN      cl_qlist_t* const       p_dest_list,
-        IN      cl_pfn_qlist_find_t     pfn_func,
+        IN      cl_qlist_t* const       p_src_list,
+        IN      cl_qlist_t* const       p_dest_list,
+        IN      cl_pfn_qlist_find_t     pfn_func,
         IN      const void* const       context );
 

PARAMETERS

       p_src_list
-               [in] Pointer to a cl_qlist_t structure from which
+               [in] Pointer to a cl_qlist_t structure from which
                list items are removed.
 
        p_dest_list
-               [in] Pointer to a cl_qlist_t structure to which the source
+               [in] Pointer to a cl_qlist_t structure to which the source
                list items are added.
 
        pfn_func
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_qlist_find_t function type declaration for details
+               See the cl_pfn_qlist_find_t function type declaration for details
                about the callback function.
 
        context
@@ -1266,13 +1266,13 @@ Component Library: Quick List/cl_qlist_move_items
        as these would corrupt the list.
 

SEE ALSO

-
       Quick List, cl_qlist_find_from_head, cl_qlist_find_from_tail,
-       cl_qlist_apply_func, cl_pfn_qlist_find_t
+
       Quick List, cl_qlist_find_from_head, cl_qlist_find_from_tail,
+       cl_qlist_apply_func, cl_pfn_qlist_find_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_next

[top][index]

@@ -1284,9 +1284,9 @@ Component Library: Quick List/cl_qlist_next

a given list item in a quick list.

SYNOPSIS

-
CL_INLINE cl_list_item_t* CL_API
+
CL_INLINE cl_list_item_t* CL_API
 cl_qlist_next(
-        IN      const cl_list_item_t* const     p_list_item )
+        IN      const cl_list_item_t* const     p_list_item )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list_item );
@@ -1297,7 +1297,7 @@ Component Library: Quick List/cl_qlist_next
 

PARAMETERS

       p_list_item
-               [in] Pointer to the cl_list_item_t whose successor to return.
+               [in] Pointer to the cl_list_item_t whose successor to return.
 
  Returns:
        Pointer to the list item following the list item specified by
@@ -1306,13 +1306,13 @@ Component Library: Quick List/cl_qlist_next
        Pointer to the list end if p_list_item was at the tail of the list.
 

SEE ALSO

-
       Quick List, cl_qlist_head, cl_qlist_tail, cl_qlist_prev, cl_qlist_end,
-       cl_list_item_t
+
       Quick List, cl_qlist_head, cl_qlist_tail, cl_qlist_prev, cl_qlist_end,
+       cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_obj

[top][index]

@@ -1320,12 +1320,12 @@ Component Library: Quick List/cl_qlist_obj

       cl_qlist_obj
 

DESCRIPTION

-
       The cl_qlist_set_obj function returns the object stored in a list object.
+
       The cl_qlist_set_obj function returns the object stored in a list object.
 

SYNOPSIS

CL_INLINE void* CL_API
 cl_qlist_obj(
-        IN      const cl_list_obj_t* const      p_list_obj )
+        IN      const cl_list_obj_t* const      p_list_obj )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list_obj );
@@ -1335,18 +1335,18 @@ Component Library: Quick List/cl_qlist_obj
 

PARAMETERS

       p_list_obj
-               [in] Pointer to a cl_list_obj_t structure.
+               [in] Pointer to a cl_list_obj_t structure.
 

RETURN VALUE

       Returns the value of the object pointer stored in the list object.
 

SEE ALSO

-
       Quick List, cl_qlist_set_obj
+
       Quick List, cl_qlist_set_obj
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_prev

[top][index]

@@ -1358,9 +1358,9 @@ Component Library: Quick List/cl_qlist_prev

a given list item in a quick list.

SYNOPSIS

-
CL_INLINE cl_list_item_t* CL_API
+
CL_INLINE cl_list_item_t* CL_API
 cl_qlist_prev(
-        IN      const cl_list_item_t* const     p_list_item )
+        IN      const cl_list_item_t* const     p_list_item )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list_item );
@@ -1371,7 +1371,7 @@ Component Library: Quick List/cl_qlist_prev
 

PARAMETERS

       p_list_item
-               [in] Pointer to the cl_list_item_t whose predecessor to return.
+               [in] Pointer to the cl_list_item_t whose predecessor to return.
 
  Returns:
        Pointer to the list item preceding the list item specified by
@@ -1380,13 +1380,13 @@ Component Library: Quick List/cl_qlist_prev
        Pointer to the list end if p_list_item was at the tail of the list.
 

SEE ALSO

-
       Quick List, cl_qlist_head, cl_qlist_tail, cl_qlist_next, cl_qlist_end,
-       cl_list_item_t
+
       Quick List, cl_qlist_head, cl_qlist_tail, cl_qlist_next, cl_qlist_end,
+       cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_remove_all

[top][index]

@@ -1399,20 +1399,20 @@ Component Library: Quick List/cl_qlist_remove_all

SYNOPSIS

CL_INLINE void CL_API
 cl_qlist_remove_all(
-        IN      cl_qlist_t* const       p_list )
+        IN      cl_qlist_t* const       p_list )
 {
 #if defined( _DEBUG_ )
-        cl_list_item_t  *p_list_item;
+        cl_list_item_t  *p_list_item;
 
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
         /* CL_ASSERT that the list was initialized. */
         CL_ASSERT( p_list->state == CL_INITIALIZED );
-        p_list_item = cl_qlist_head( p_list );
-        while( p_list_item != cl_qlist_end( p_list ) )
+        p_list_item = cl_qlist_head( p_list );
+        while( p_list_item != cl_qlist_end( p_list ) )
         {
-                p_list_item = cl_qlist_next( p_list_item );
-                cl_qlist_prev( p_list_item )->p_list = NULL;
+                p_list_item = cl_qlist_next( p_list_item );
+                cl_qlist_prev( p_list_item )->p_list = NULL;
         }
 #endif
 
@@ -1421,19 +1421,19 @@ Component Library: Quick List/cl_qlist_remove_all
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 

RETURN VALUE

       This function does not return a value.
 

SEE ALSO

-
       Quick List, cl_qlist_remove_head, cl_qlist_remove_tail,
-       cl_qlist_remove_item, cl_list_item_t
+
       Quick List, cl_qlist_remove_head, cl_qlist_remove_tail,
+       cl_qlist_remove_item, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_remove_head

[top][index]

@@ -1445,22 +1445,22 @@ Component Library: Quick List/cl_qlist_remove_head

at the head of a quick list.

SYNOPSIS

-
CL_INLINE cl_list_item_t* CL_API
+
CL_INLINE cl_list_item_t* CL_API
 cl_qlist_remove_head(
-        IN      cl_qlist_t* const       p_list )
+        IN      cl_qlist_t* const       p_list )
 {
-        cl_list_item_t  *p_item;
+        cl_list_item_t  *p_item;
 
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
         /* CL_ASSERT that the list was initialized. */
         CL_ASSERT( p_list->state == CL_INITIALIZED );
 
-        p_item = cl_qlist_head( p_list );
+        p_item = cl_qlist_head( p_list );
         /* CL_ASSERT that the list item is part of the list. */
         CL_ASSERT( p_item->p_list == p_list );
 
-        if( p_item == cl_qlist_end( p_list ) )
+        if( p_item == cl_qlist_end( p_list ) )
                 return( p_item );
 
 #if defined( _DEBUG_ )
@@ -1477,7 +1477,7 @@ Component Library: Quick List/cl_qlist_remove_head
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 
  RETURN VALUES
        Returns a pointer to the list item formerly at the head of the quick list.
@@ -1485,13 +1485,13 @@ Component Library: Quick List/cl_qlist_remove_head
        Pointer to the list end if the list was empty.
 

SEE ALSO

-
       Quick List, cl_qlist_remove_tail, cl_qlist_remove_all, cl_qlist_remove_item,
-       cl_qlist_end, cl_qlist_head, cl_list_item_t
+
       Quick List, cl_qlist_remove_tail, cl_qlist_remove_all, cl_qlist_remove_item,
+       cl_qlist_end, cl_qlist_head, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_remove_item

[top][index]

@@ -1504,8 +1504,8 @@ Component Library: Quick List/cl_qlist_remove_item

SYNOPSIS

CL_INLINE void CL_API
 cl_qlist_remove_item(
-        IN      cl_qlist_t* const               p_list,
-        IN      cl_list_item_t* const   p_list_item )
+        IN      cl_qlist_t* const               p_list,
+        IN      cl_list_item_t* const   p_list_item )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
@@ -1516,7 +1516,7 @@ Component Library: Quick List/cl_qlist_remove_item
         /* CL_ASSERT that the list item is part of the list. */
         CL_ASSERT( p_list_item->p_list == p_list );
 
-        if( p_list_item == cl_qlist_end( p_list ) )
+        if( p_list_item == cl_qlist_end( p_list ) )
                 return;
 
 #if defined( _DEBUG_ )
@@ -1531,10 +1531,10 @@ Component Library: Quick List/cl_qlist_remove_item
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure from which to remove the item.
+               [in] Pointer to a cl_qlist_t structure from which to remove the item.
 
        p_list_item
-               [in] Pointer to a cl_list_item_t structure to remove.
+               [in] Pointer to a cl_list_item_t structure to remove.
 

RETURN VALUE

       This function does not return a value.
@@ -1544,13 +1544,13 @@ Component Library: Quick List/cl_qlist_remove_item
        its list.
 

SEE ALSO

-
       Quick List, cl_qlist_remove_head, cl_qlist_remove_tail, cl_qlist_remove_all,
-       cl_list_item_t
+
       Quick List, cl_qlist_remove_head, cl_qlist_remove_tail, cl_qlist_remove_all,
+       cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_remove_tail

[top][index]

@@ -1562,22 +1562,22 @@ Component Library: Quick List/cl_qlist_remove_tail

at the tail of a quick list.

SYNOPSIS

-
CL_INLINE cl_list_item_t* CL_API
+
CL_INLINE cl_list_item_t* CL_API
 cl_qlist_remove_tail(
-        IN      cl_qlist_t* const       p_list )
+        IN      cl_qlist_t* const       p_list )
 {
-        cl_list_item_t  *p_item;
+        cl_list_item_t  *p_item;
 
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
         /* CL_ASSERT that the list was initialized. */
         CL_ASSERT( p_list->state == CL_INITIALIZED );
 
-        p_item = cl_qlist_tail( p_list );
+        p_item = cl_qlist_tail( p_list );
         /* CL_ASSERT that the list item is part of the list. */
         CL_ASSERT( p_item->p_list == p_list );
 
-        if( p_item == cl_qlist_end( p_list ) )
+        if( p_item == cl_qlist_end( p_list ) )
                 return( p_item );
 
 #if defined( _DEBUG_ )
@@ -1594,7 +1594,7 @@ Component Library: Quick List/cl_qlist_remove_tail
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 
  RETURN VALUES
        Returns a pointer to the list item formerly at the tail of the quick list.
@@ -1602,13 +1602,13 @@ Component Library: Quick List/cl_qlist_remove_tail
        Pointer to the list end if the list was empty.
 

SEE ALSO

-
       Quick List, cl_qlist_remove_head, cl_qlist_remove_all, cl_qlist_remove_item,
-       cl_qlist_end, cl_qlist_tail, cl_list_item_t
+
       Quick List, cl_qlist_remove_head, cl_qlist_remove_all, cl_qlist_remove_item,
+       cl_qlist_end, cl_qlist_tail, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_set_obj

[top][index]

@@ -1621,7 +1621,7 @@ Component Library: Quick List/cl_qlist_set_obj

SYNOPSIS

CL_INLINE void CL_API
 cl_qlist_set_obj(
-        IN      cl_list_obj_t* const    p_list_obj,
+        IN      cl_list_obj_t* const    p_list_obj,
         IN      const void* const               p_object )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
@@ -1631,7 +1631,7 @@ Component Library: Quick List/cl_qlist_set_obj
 

PARAMETERS

       p_list_obj
-               [in] Pointer to a cl_list_obj_t structure.
+               [in] Pointer to a cl_list_obj_t structure.
 
        p_object
                [in] User defined context.
@@ -1640,12 +1640,12 @@ Component Library: Quick List/cl_qlist_set_obj
 
       This function does not return a value.
 

SEE ALSO

-
       Quick List, cl_qlist_obj
+
       Quick List, cl_qlist_obj
 

-

[Structures] +

[Structures] Component Library: Quick List/cl_qlist_t

[top][index]

@@ -1661,7 +1661,7 @@ Component Library: Quick List/cl_qlist_t

SYNOPSIS

typedef struct _cl_qlist
 {
-        cl_list_item_t  end;
+        cl_list_item_t  end;
         size_t                  count;
         cl_state_t              state;
 
@@ -1669,7 +1669,7 @@ Component Library: Quick List/cl_qlist_t
 

FIELDS

       end
-               List item used to mark the end of the list.
+               List item used to mark the end of the list.
 
        count
                Number of items in the list.
@@ -1678,12 +1678,12 @@ Component Library: Quick List/cl_qlist_t
                State of the quick list.
 

SEE ALSO

-
       Quick List
+
       Quick List
 

-

[Functions] +

[Functions] Component Library: Quick List/cl_qlist_tail

[top][index]

@@ -1695,21 +1695,21 @@ Component Library: Quick List/cl_qlist_tail

the tail of a quick list.

SYNOPSIS

-
CL_INLINE cl_list_item_t* CL_API
+
CL_INLINE cl_list_item_t* CL_API
 cl_qlist_tail(
-        IN      const cl_qlist_t* const p_list )
+        IN      const cl_qlist_t* const p_list )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_list );
         /* CL_ASSERT that the list was initialized. */
         CL_ASSERT( p_list->state == CL_INITIALIZED );
 
-        return( cl_qlist_prev( &p_list->end ) );
+        return( cl_qlist_prev( &p_list->end ) );
 }
 

PARAMETERS

       p_list
-               [in] Pointer to a cl_qlist_t structure.
+               [in] Pointer to a cl_qlist_t structure.
 
  RETURN VALUES
        Pointer to the list item at the tail of the quick list.
@@ -1720,8 +1720,8 @@ Component Library: Quick List/cl_qlist_tail
 
       cl_qlist_tail does not remove the item from the list.
 

SEE ALSO

-
       Quick List, cl_qlist_head, cl_qlist_next, cl_qlist_prev, cl_qlist_end,
-       cl_list_item_t
+
       Quick List, cl_qlist_head, cl_qlist_next, cl_qlist_prev, cl_qlist_end,
+       cl_list_item_t
 
diff --git a/trunk/docs/complib/cl_qlockpool_h.html b/trunk/docs/complib/cl_qlockpool_h.html index 540962c4..aa99465f 100644 --- a/trunk/docs/complib/cl_qlockpool_h.html +++ b/trunk/docs/complib/cl_qlockpool_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_qlockpool_h.html +./inc_docs/complib/cl_qlockpool_h.html -Generated from ./inc/complib/cl_qlockpool.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_qlockpool.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Quick Locking Pool

-

[top][index]

+

[top][parent][index]

NAME

       Quick Locking Pool
 
@@ -26,18 +26,18 @@ Component Library/Quick Locking Pool

SEE ALSO

       Structures:
-               cl_qlock_pool_t
+               cl_qlock_pool_t
 
        Initialization:
-               cl_qlock_pool_construct, cl_qlock_pool_init, cl_qlock_pool_destroy
+               cl_qlock_pool_construct, cl_qlock_pool_init, cl_qlock_pool_destroy
 
        Manipulation
-               cl_qlock_pool_get, cl_qlock_pool_put
+               cl_qlock_pool_get, cl_qlock_pool_put
 

-

[Functions] +

[Functions] Component Library: Quick Locking Pool/cl_qlock_pool_construct

[top][index]

@@ -50,10 +50,10 @@ Component Library: Quick Locking Pool/cl_qlock_pool_construct

SYNOPSIS

static inline void
 cl_qlock_pool_construct(
-        IN cl_qlock_pool_t* const p_pool )
+        IN cl_qlock_pool_t* const p_pool )
 {
-        cl_qpool_construct( &p_pool->pool );
-        cl_spinlock_construct( &p_pool->lock );
+        cl_qpool_construct( &p_pool->pool );
+        cl_spinlock_construct( &p_pool->lock );
 }
 

PARAMETERS

@@ -64,18 +64,18 @@ Component Library: Quick Locking Pool/cl_qlock_pool_construct
       This function does not return a value.
 

NOTES

-
       Allows calling cl_qlock_pool_init, cl_qlock_pool_destroy
+
       Allows calling cl_qlock_pool_init, cl_qlock_pool_destroy
 
        Calling cl_qlock_pool_construct is a prerequisite to calling any other
-       method except cl_qlock_pool_init.
+       method except cl_qlock_pool_init.
 

SEE ALSO

-
       Quick Locking Pool, cl_qlock_pool_init, cl_qlock_pool_destroy
+
       Quick Locking Pool, cl_qlock_pool_init, cl_qlock_pool_destroy
 

-

[Functions] +

[Functions] Component Library: Quick Locking Pool/cl_qlock_pool_destroy

[top][index]

@@ -89,22 +89,22 @@ Component Library: Quick Locking Pool/cl_qlock_pool_destroy

SYNOPSIS

static inline void
 cl_qlock_pool_destroy(
-        IN cl_qlock_pool_t* const p_pool )
+        IN cl_qlock_pool_t* const p_pool )
 {
         /*
                 If the pool has already been put into use, grab the lock
                 to sync with other threads before we blow everything away.
         */
-        if( cl_is_qpool_inited( &p_pool->pool ) )
+        if( cl_is_qpool_inited( &p_pool->pool ) )
         {
-                cl_spinlock_acquire( &p_pool->lock );
-                cl_qpool_destroy( &p_pool->pool );
-                cl_spinlock_release( &p_pool->lock );
+                cl_spinlock_acquire( &p_pool->lock );
+                cl_qpool_destroy( &p_pool->pool );
+                cl_spinlock_release( &p_pool->lock );
         }
         else
-                cl_qpool_destroy( &p_pool->pool );
+                cl_qpool_destroy( &p_pool->pool );
 
-        cl_spinlock_destroy( &p_pool->lock );
+        cl_spinlock_destroy( &p_pool->lock );
 }
 

PARAMETERS

@@ -118,15 +118,15 @@ Component Library: Quick Locking Pool/cl_qlock_pool_destroy
       Performs any necessary cleanup of the specified Quick Locking Pool.
        Further operations should not be attempted on the destroyed object.
        This function should only be called after a call to
-       cl_qlock_pool_construct or cl_qlock_pool_init.
+       cl_qlock_pool_construct or cl_qlock_pool_init.
 

SEE ALSO

-
       Quick Locking Pool, cl_qlock_pool_construct, cl_qlock_pool_init
+
       Quick Locking Pool, cl_qlock_pool_construct, cl_qlock_pool_init
 

-

[Functions] +

[Functions] Component Library: Quick Locking Pool/cl_qlock_pool_get

[top][index]

@@ -137,38 +137,38 @@ Component Library: Quick Locking Pool/cl_qlock_pool_get

       Gets an object wrapper and wire MAD from the pool.
 

SYNOPSIS

-
static inline cl_pool_item_t*
+
static inline cl_pool_item_t*
 cl_qlock_pool_get(
-        IN cl_qlock_pool_t* const p_pool )
+        IN cl_qlock_pool_t* const p_pool )
 {
-        cl_pool_item_t* p_item;
-        cl_spinlock_acquire( &p_pool->lock );
-        p_item = cl_qpool_get( &p_pool->pool );
-        cl_spinlock_release( &p_pool->lock );
+        cl_pool_item_t* p_item;
+        cl_spinlock_acquire( &p_pool->lock );
+        p_item = cl_qpool_get( &p_pool->pool );
+        cl_spinlock_release( &p_pool->lock );
         return( p_item );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to an cl_qlock_pool_t object.
+               [in] Pointer to an cl_qlock_pool_t object.
 
  RETURN VALUES
-       Returns a pointer to a cl_pool_item_t contained in the user object.
+       Returns a pointer to a cl_pool_item_t contained in the user object.
 

NOTES

       The object must eventually be returned to the pool with a call to
-       cl_qlock_pool_put.
+       cl_qlock_pool_put.
 
-       The cl_qlock_pool_construct or cl_qlock_pool_init must be called before
+       The cl_qlock_pool_construct or cl_qlock_pool_init must be called before
        using this function.
 

SEE ALSO

-
       Quick Locking Pool, cl_qlock_pool_put
+
       Quick Locking Pool, cl_qlock_pool_put
 

-

[Functions] +

[Functions] Component Library: Quick Locking Pool/cl_qlock_pool_init

[top][index]

@@ -179,26 +179,26 @@ Component Library: Quick Locking Pool/cl_qlock_pool_init

       The cl_qlock_pool_init function initializes a Quick Locking Pool for use.
 

SYNOPSIS

-
static inline cl_status_t
+
static inline cl_status_t
 cl_qlock_pool_init(
-        IN cl_qlock_pool_t*                     const p_pool,
+        IN cl_qlock_pool_t*                     const p_pool,
         IN      const size_t                    min_size,
         IN      const size_t                    max_size,
         IN      const size_t                    grow_size,
         IN      const size_t                    object_size,
-        IN      cl_pfn_qpool_init_t             pfn_initializer OPTIONAL,
-        IN      cl_pfn_qpool_dtor_t             pfn_destructor OPTIONAL,
+        IN      cl_pfn_qpool_init_t             pfn_initializer OPTIONAL,
+        IN      cl_pfn_qpool_dtor_t             pfn_destructor OPTIONAL,
         IN      const void* const               context )
 {
-        cl_status_t status;
+        cl_status_t status;
 
-        cl_qlock_pool_construct( p_pool );
+        cl_qlock_pool_construct( p_pool );
 
-        status = cl_spinlock_init( &p_pool->lock );
+        status = cl_spinlock_init( &p_pool->lock );
         if( status )
                 return( status );
 
-        status = cl_qpool_init( &p_pool->pool, min_size, max_size, grow_size,
+        status = cl_qpool_init( &p_pool->pool, min_size, max_size, grow_size,
                         object_size, pfn_initializer, pfn_destructor, context );
 
         return( status );
@@ -206,7 +206,7 @@ Component Library: Quick Locking Pool/cl_qlock_pool_init
 

PARAMETERS

       p_pool
-               [in] Pointer to an cl_qlock_pool_t object to initialize.
+               [in] Pointer to an cl_qlock_pool_t object to initialize.
 
        min_size
                [in] Minimum number of objects that the pool should support. All
@@ -228,14 +228,14 @@ Component Library: Quick Locking Pool/cl_qlock_pool_init
        pfn_initializer
                [in] Initialization callback to invoke for every new object when
                growing the pool. This parameter is optional and may be NULL. If NULL,
-               the pool assumes the cl_pool_item_t structure describing objects is
-               located at the head of each object. See the cl_pfn_qpool_init_t
+               the pool assumes the cl_pool_item_t structure describing objects is
+               located at the head of each object. See the cl_pfn_qpool_init_t
                function type declaration for details about the callback function.
 
        pfn_destructor
                [in] Destructor callback to invoke for every object before memory for
                that object is freed. This parameter is optional and may be NULL.
-               See the cl_pfn_qpool_dtor_t function type declaration for details
+               See the cl_pfn_qpool_dtor_t function type declaration for details
                about the callback function.
 
        context
@@ -250,19 +250,19 @@ Component Library: Quick Locking Pool/cl_qlock_pool_init
        CL_INVALID_SETTING if a the maximum size is non-zero and less than the
        minimum size.
 
-       Other cl_status_t value returned by optional initialization callback function
+       Other cl_status_t value returned by optional initialization callback function
        specified by the pfn_initializer parameter.
 

NOTES

       Allows calling other Quick Locking Pool methods.
 

SEE ALSO

-
       Quick Locking Pool, cl_qlock_pool_construct, cl_qlock_pool_destroy
+
       Quick Locking Pool, cl_qlock_pool_construct, cl_qlock_pool_destroy
 

-

[Functions] +

[Functions] Component Library: Quick Locking Pool/cl_qlock_pool_put

[top][index]

@@ -275,36 +275,36 @@ Component Library: Quick Locking Pool/cl_qlock_pool_put

SYNOPSIS

static inline void
 cl_qlock_pool_put(
-        IN cl_qlock_pool_t* const p_pool,
-        IN cl_pool_item_t* const p_item )
+        IN cl_qlock_pool_t* const p_pool,
+        IN cl_pool_item_t* const p_item )
 {
-        cl_spinlock_acquire( &p_pool->lock );
-        cl_qpool_put( &p_pool->pool, p_item );
-        cl_spinlock_release( &p_pool->lock );
+        cl_spinlock_acquire( &p_pool->lock );
+        cl_qpool_put( &p_pool->pool, p_item );
+        cl_spinlock_release( &p_pool->lock );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to an cl_qlock_pool_t object.
+               [in] Pointer to an cl_qlock_pool_t object.
 
        p_item
-               [in] Pointer to the cl_pool_item_t in an object that was previously
+               [in] Pointer to the cl_pool_item_t in an object that was previously
                retrieved from the pool.
 
  RETURN VALUES
        This function does not return a value.
 

NOTES

-
       The cl_qlock_pool_construct or cl_qlock_pool_init must be called before
+
       The cl_qlock_pool_construct or cl_qlock_pool_init must be called before
        using this function.
 

SEE ALSO

-
       Quick Locking Pool, cl_qlock_pool_get
+
       Quick Locking Pool, cl_qlock_pool_get
 

-

[Structures] +

[Structures] Component Library: Quick Locking Pool/cl_qlock_pool_t

[top][index]

@@ -321,7 +321,7 @@ Component Library: Quick Locking Pool/cl_qlock_pool_t

typedef struct _cl_qlock_pool
 {
         cl_spinlock_t                           lock;
-        cl_qpool_t                                      pool;
+        cl_qpool_t                                      pool;
 
 } cl_qlock_pool_t;
 
diff --git a/trunk/docs/complib/cl_qmap_h.html b/trunk/docs/complib/cl_qmap_h.html index bb29ece9..c6c142b1 100644 --- a/trunk/docs/complib/cl_qmap_h.html +++ b/trunk/docs/complib/cl_qmap_h.html @@ -2,24 +2,24 @@ -./inc_doc/complib/cl_qmap_h.html +./inc_docs/complib/cl_qmap_h.html -Generated from ./inc/complib/cl_qmap.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_qmap.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Quick Map

-

[top][index]

+

[top][parent][index]

NAME

-
       Quick Map
+
       Quick Map
 

DESCRIPTION

-
       Quick map implements a binary tree that stores user provided cl_map_item_t
+
       Quick map implements a binary tree that stores user provided cl_map_item_t
        structures.  Each item stored in a quick map has a unique 64-bit key
        (duplicates are not allowed).  Quick map provides the ability to
        efficiently search for an item given a key.
@@ -31,40 +31,40 @@ Component Library/Quick Map
        Quick map is not thread safe, and users must provide serialization when
        adding and removing items from the map.
 
-       The quick map functions operate on a cl_qmap_t structure which should be
+       The quick map functions operate on a cl_qmap_t structure which should be
        treated as opaque and should be manipulated only through the provided
        functions.
 

SEE ALSO

       Structures:
-               cl_qmap_t, cl_map_item_t, cl_map_obj_t
+               cl_qmap_t, cl_map_item_t, cl_map_obj_t
 
        Callbacks:
-               cl_pfn_qmap_apply_t
+               cl_pfn_qmap_apply_t
 
        Item Manipulation:
-               cl_qmap_set_obj, cl_qmap_obj, cl_qmap_key
+               cl_qmap_set_obj, cl_qmap_obj, cl_qmap_key
 
        Initialization:
-               cl_qmap_init
+               cl_qmap_init
 
        Iteration:
-               cl_qmap_end, cl_qmap_head, cl_qmap_tail, cl_qmap_next, cl_qmap_prev
+               cl_qmap_end, cl_qmap_head, cl_qmap_tail, cl_qmap_next, cl_qmap_prev
 
        Manipulation:
-               cl_qmap_insert, cl_qmap_get, cl_qmap_remove_item, cl_qmap_remove,
-               cl_qmap_remove_all, cl_qmap_merge, cl_qmap_delta
+               cl_qmap_insert, cl_qmap_get, cl_qmap_remove_item, cl_qmap_remove,
+               cl_qmap_remove_all, cl_qmap_merge, cl_qmap_delta
 
        Search:
-               cl_qmap_apply_func
+               cl_qmap_apply_func
 
        Attributes:
-               cl_qmap_count, cl_is_qmap_empty,
+               cl_qmap_count, cl_is_qmap_empty,
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_is_qmap_empty

[top][index]

@@ -77,7 +77,7 @@ Component Library: Quick Map/cl_is_qmap_empty

SYNOPSIS

CL_INLINE boolean_t CL_API
 cl_is_qmap_empty(
-        IN      const cl_qmap_t* const  p_map )
+        IN      const cl_qmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -87,7 +87,7 @@ Component Library: Quick Map/cl_is_qmap_empty
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure to test for emptiness.
+               [in] Pointer to a cl_qmap_t structure to test for emptiness.
 
  RETURN VALUES
        TRUE if the quick map is empty.
@@ -95,12 +95,12 @@ Component Library: Quick Map/cl_is_qmap_empty
        FALSE otherwise.
 

SEE ALSO

-
       Quick Map, cl_qmap_count, cl_qmap_remove_all
+
       Quick Map, cl_qmap_count, cl_qmap_remove_all
 

-

[Structures] +

[Structures] Component Library: Quick Map/cl_map_item_t

[top][index]

@@ -117,7 +117,7 @@ Component Library: Quick Map/cl_map_item_t

typedef struct _cl_map_item
 {
         /* Must be first to allow casting. */
-        cl_pool_item_t                  pool_item;
+        cl_pool_item_t                  pool_item;
         struct _cl_map_item             *p_left;
         struct _cl_map_item             *p_right;
         struct _cl_map_item             *p_up;
@@ -145,14 +145,14 @@ Component Library: Quick Map/cl_map_item_t
 
        p_nil
                Pointer to the map's NIL item, used as a terminator for leaves.
-               The NIL sentinel is in the cl_qmap_t structure.
+               The NIL sentinel is in the cl_qmap_t structure.
 
        color
                Indicates whether a node is red or black in the map.
 
        key
                Value that uniquely represents a node in a map.  This value is set by
-               calling cl_qmap_insert and can be retrieved by calling cl_qmap_key.
+               calling cl_qmap_insert and can be retrieved by calling cl_qmap_key.
 

NOTES

       None of the fields of this structure should be manipulated by users, as
@@ -167,12 +167,12 @@ Component Library: Quick Map/cl_map_item_t
        to be stored in a quick list, a quick pool, and a quick map.
 

SEE ALSO

-
       Quick Map, cl_qmap_insert, cl_qmap_key, cl_pool_item_t, cl_list_item_t
+
       Quick Map, cl_qmap_insert, cl_qmap_key, cl_pool_item_t, cl_list_item_t
 

-

[Structures] +

[Structures] Component Library: Quick Map/cl_map_obj_t

[top][index]

@@ -186,20 +186,20 @@ Component Library: Quick Map/cl_map_obj_t

be manipulated only through the provided functions.

SYNOPSIS

-
typedef struct _cl_map_obj
+
typedef struct _cl_map_obj
 {
-        cl_map_item_t                   item;
+        cl_map_item_t                   item;
         const void                              *p_object;
 
 } cl_map_obj_t;
 

FIELDS

       item
-               Map item used by internally by the map to store an object.
+               Map item used by internally by the map to store an object.
 
        p_object
                User defined context. Users should not access this field directly.
-               Use cl_qmap_set_obj and cl_qmap_obj to set and retrieve the value
+               Use cl_qmap_set_obj and cl_qmap_obj to set and retrieve the value
                of this field.
 

NOTES

@@ -207,16 +207,16 @@ Component Library: Quick Map/cl_map_obj_t they are crititcal to the proper operation of the map in which they are stored. - Use cl_qmap_set_obj and cl_qmap_obj to set and retrieve the object + Use cl_qmap_set_obj and cl_qmap_obj to set and retrieve the object stored in a map item, respectively.

SEE ALSO

-
       Quick Map, cl_qmap_set_obj, cl_qmap_obj, cl_map_item_t
+
       Quick Map, cl_qmap_set_obj, cl_qmap_obj, cl_map_item_t
 

-

[Definitions] +

[Definitions] Component Library: Quick Map/cl_pfn_qmap_apply_t

[top][index]

@@ -230,12 +230,12 @@ Component Library: Quick Map/cl_pfn_qmap_apply_t

SYNOPSIS

typedef void
 (CL_API *cl_pfn_qmap_apply_t)(
-        IN      cl_map_item_t* const    p_map_item,
+        IN      cl_map_item_t* const    p_map_item,
         IN      void*                                   context );
 

PARAMETERS

       p_map_item
-               [in] Pointer to a cl_map_item_t structure.
+               [in] Pointer to a cl_map_item_t structure.
 
        context
                [in] Value passed to the callback function.
@@ -245,16 +245,16 @@ Component Library: Quick Map/cl_pfn_qmap_apply_t
 

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_qmap_apply_func
+       function provided by users as a parameter to the cl_qmap_apply_func
        function.
 

SEE ALSO

-
       Quick Map, cl_qmap_apply_func
+
       Quick Map, cl_qmap_apply_func
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_apply_func

[top][index]

@@ -268,17 +268,17 @@ Component Library: Quick Map/cl_qmap_apply_func

SYNOPSIS

CL_EXPORT void CL_API
 cl_qmap_apply_func(
-        IN      const cl_qmap_t* const  p_map,
-        IN      cl_pfn_qmap_apply_t             pfn_func,
+        IN      const cl_qmap_t* const  p_map,
+        IN      cl_pfn_qmap_apply_t             pfn_func,
         IN      const void* const               context );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure.
+               [in] Pointer to a cl_qmap_t structure.
 
        pfn_func
                [in] Function invoked for every item in the quick map.
-               See the cl_pfn_qmap_apply_t function type declaration for details
+               See the cl_pfn_qmap_apply_t function type declaration for details
                about the callback function.
 
        context
@@ -292,12 +292,12 @@ Component Library: Quick Map/cl_qmap_apply_func
        would corrupt the quick map.
 

SEE ALSO

-
       Quick Map, cl_pfn_qmap_apply_t
+
       Quick Map, cl_pfn_qmap_apply_t
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_count

[top][index]

@@ -311,7 +311,7 @@ Component Library: Quick Map/cl_qmap_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_qmap_count(
-        IN      const cl_qmap_t* const  p_map )
+        IN      const cl_qmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -320,18 +320,18 @@ Component Library: Quick Map/cl_qmap_count
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure whose item count to return.
+               [in] Pointer to a cl_qmap_t structure whose item count to return.
 

RETURN VALUE

       Returns the number of items stored in the map.
 

SEE ALSO

-
       Quick Map, cl_is_qmap_empty
+
       Quick Map, cl_is_qmap_empty
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_delta

[top][index]

@@ -344,26 +344,26 @@ Component Library: Quick Map/cl_qmap_delta

SYNOPSIS

CL_EXPORT void CL_API
 cl_qmap_delta(
-        IN OUT  cl_qmap_t* const        p_map1,
-        IN OUT  cl_qmap_t* const        p_map2,
-        OUT             cl_qmap_t* const        p_new,
-        OUT             cl_qmap_t* const        p_old );
+        IN OUT  cl_qmap_t* const        p_map1,
+        IN OUT  cl_qmap_t* const        p_map2,
+        OUT             cl_qmap_t* const        p_new,
+        OUT             cl_qmap_t* const        p_old );
 

PARAMETERS

       p_map1
-               [in/out] Pointer to the first of two cl_qmap_t structures whose
+               [in/out] Pointer to the first of two cl_qmap_t structures whose
                differences to compute.
 
        p_map2
-               [in/out] Pointer to the second of two cl_qmap_t structures whose
+               [in/out] Pointer to the second of two cl_qmap_t structures whose
                differences to compute.
 
        p_new
-               [out] Pointer to an empty cl_qmap_t structure that contains the items
+               [out] Pointer to an empty cl_qmap_t structure that contains the items
                unique to p_map2 upon return from the function.
 
        p_old
-               [out] Pointer to an empty cl_qmap_t structure that contains the items
+               [out] Pointer to an empty cl_qmap_t structure that contains the items
                unique to p_map1 upon return from the function.
 
  RETURN VALUES
@@ -380,12 +380,12 @@ Component Library: Quick Map/cl_qmap_delta
        requirement removes the possibility of failures.
 

SEE ALSO

-
       Quick Map, cl_qmap_merge
+
       Quick Map, cl_qmap_merge
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_end

[top][index]

@@ -396,9 +396,9 @@ Component Library: Quick Map/cl_qmap_end

       The cl_qmap_end function returns the end of a quick map.
 

SYNOPSIS

-
CL_INLINE const cl_map_item_t* const CL_API
+
CL_INLINE const cl_map_item_t* const CL_API
 cl_qmap_end(
-        IN      const cl_qmap_t* const  p_map )
+        IN      const cl_qmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -408,26 +408,26 @@ Component Library: Quick Map/cl_qmap_end
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure whose end to return.
+               [in] Pointer to a cl_qmap_t structure whose end to return.
 

RETURN VALUE

       Pointer to the end of the map.
 

NOTES

       cl_qmap_end is useful for determining the validity of map items returned
-       by cl_qmap_head, cl_qmap_tail, cl_qmap_next, or cl_qmap_prev.  If the map
+       by cl_qmap_head, cl_qmap_tail, cl_qmap_next, or cl_qmap_prev.  If the map
        item pointer returned by any of these functions compares to the end, the
        end of the map was encoutered.
-       When using cl_qmap_head or cl_qmap_tail, this condition indicates that
+       When using cl_qmap_head or cl_qmap_tail, this condition indicates that
        the map is empty.
 

SEE ALSO

-
       Quick Map, cl_qmap_head, cl_qmap_tail, cl_qmap_next, cl_qmap_prev
+
       Quick Map, cl_qmap_head, cl_qmap_tail, cl_qmap_next, cl_qmap_prev
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_get

[top][index]

@@ -438,14 +438,14 @@ Component Library: Quick Map/cl_qmap_get

       The cl_qmap_get function returns the map item associated with a key.
 

SYNOPSIS

-
CL_EXPORT cl_map_item_t* CL_API
+
CL_EXPORT cl_map_item_t* CL_API
 cl_qmap_get(
-        IN      const cl_qmap_t* const  p_map,
+        IN      const cl_qmap_t* const  p_map,
         IN      const uint64_t                  key );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure from which to retrieve the
+               [in] Pointer to a cl_qmap_t structure from which to retrieve the
                item with the specified key.
 
        key
@@ -461,12 +461,12 @@ Component Library: Quick Map/cl_qmap_get
 
       cl_qmap_get does not remove the item from the quick map.
 

SEE ALSO

-
       Quick Map, cl_qmap_remove
+
       Quick Map, cl_qmap_remove
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_head

[top][index]

@@ -478,18 +478,18 @@ Component Library: Quick Map/cl_qmap_head

value stored in a quick map.

SYNOPSIS

-
CL_INLINE cl_map_item_t* CL_API
+
CL_INLINE cl_map_item_t* CL_API
 cl_qmap_head(
-        IN      const cl_qmap_t* const  p_map )
+        IN      const cl_qmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
-        return( (cl_map_item_t*)p_map->nil.pool_item.list_item.p_next );
+        return( (cl_map_item_t*)p_map->nil.pool_item.list_item.p_next );
 }
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure whose item with the lowest key
+               [in] Pointer to a cl_qmap_t structure whose item with the lowest key
                is returned.
 
  RETURN VALUES
@@ -501,13 +501,13 @@ Component Library: Quick Map/cl_qmap_head
 
       cl_qmap_head does not remove the item from the map.
 

SEE ALSO

-
       Quick Map, cl_qmap_tail, cl_qmap_next, cl_qmap_prev, cl_qmap_end,
+
       Quick Map, cl_qmap_tail, cl_qmap_next, cl_qmap_prev, cl_qmap_end,
        cl_qmap_item_t
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_init

[top][index]

@@ -520,11 +520,11 @@ Component Library: Quick Map/cl_qmap_init

SYNOPSIS

CL_EXPORT void CL_API
 cl_qmap_init(
-        IN      cl_qmap_t* const        p_map );
+        IN      cl_qmap_t* const        p_map );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure to initialize.
+               [in] Pointer to a cl_qmap_t structure to initialize.
 
  RETURN VALUES
        This function does not return a value.
@@ -533,12 +533,12 @@ Component Library: Quick Map/cl_qmap_init
 
       Allows calling quick map manipulation functions.
 

SEE ALSO

-
       Quick Map, cl_qmap_insert, cl_qmap_remove
+
       Quick Map, cl_qmap_insert, cl_qmap_remove
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_insert

[top][index]

@@ -549,21 +549,21 @@ Component Library: Quick Map/cl_qmap_insert

       The cl_qmap_insert function inserts a map item into a quick map.
 

SYNOPSIS

-
CL_EXPORT cl_map_item_t* CL_API
+
CL_EXPORT cl_map_item_t* CL_API
 cl_qmap_insert(
-        IN      cl_qmap_t* const                p_map,
+        IN      cl_qmap_t* const                p_map,
         IN      const uint64_t                  key,
-        IN      cl_map_item_t* const    p_item );
+        IN      cl_map_item_t* const    p_item );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure into which to add the item.
+               [in] Pointer to a cl_qmap_t structure into which to add the item.
 
        key
                [in] Value to assign to the item.
 
        p_item
-               [in] Pointer to a cl_map_item_t stucture to insert into the quick map.
+               [in] Pointer to a cl_map_item_t stucture to insert into the quick map.
 

RETURN VALUE

       Pointer to the item in the map with the specified key.  If insertion
@@ -575,12 +575,12 @@ Component Library: Quick Map/cl_qmap_insert
 
       Insertion operations may cause the quick map to rebalance.
 

SEE ALSO

-
       Quick Map, cl_qmap_remove, cl_map_item_t
+
       Quick Map, cl_qmap_remove, cl_map_item_t
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_key

[top][index]

@@ -593,7 +593,7 @@ Component Library: Quick Map/cl_qmap_key

SYNOPSIS

CL_INLINE uint64_t CL_API
 cl_qmap_key(
-        IN      const cl_map_item_t* const      p_item )
+        IN      const cl_map_item_t* const      p_item )
 {
         CL_ASSERT( p_item );
         return( p_item->key );
@@ -607,15 +607,15 @@ Component Library: Quick Map/cl_qmap_key
 
       Returns the 64-bit key value for the specified map item.
 

NOTES

-
       The key value is set in a call to cl_qmap_insert.
+
       The key value is set in a call to cl_qmap_insert.
 

SEE ALSO

-
       Quick Map, cl_qmap_insert
+
       Quick Map, cl_qmap_insert
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_merge

[top][index]

@@ -629,15 +629,15 @@ Component Library: Quick Map/cl_qmap_merge

SYNOPSIS

CL_EXPORT void CL_API
 cl_qmap_merge(
-        OUT             cl_qmap_t* const        p_dest_map,
-        IN OUT  cl_qmap_t* const        p_src_map );
+        OUT             cl_qmap_t* const        p_dest_map,
+        IN OUT  cl_qmap_t* const        p_src_map );
 

PARAMETERS

       p_dest_map
-               [out] Pointer to a cl_qmap_t structure to which items should be added.
+               [out] Pointer to a cl_qmap_t structure to which items should be added.
 
        p_src_map
-               [in/out] Pointer to a cl_qmap_t structure whose items to add
+               [in/out] Pointer to a cl_qmap_t structure whose items to add
                to p_dest_map.
 
  RETURN VALUES
@@ -650,12 +650,12 @@ Component Library: Quick Map/cl_qmap_merge
        contains all duplicate items.
 

SEE ALSO

-
       Quick Map, cl_qmap_delta
+
       Quick Map, cl_qmap_delta
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_next

[top][index]

@@ -667,12 +667,12 @@ Component Library: Quick Map/cl_qmap_next

key value than a specified map item.

SYNOPSIS

-
CL_INLINE cl_map_item_t* CL_API
+
CL_INLINE cl_map_item_t* CL_API
 cl_qmap_next(
-        IN      const cl_map_item_t* const      p_item )
+        IN      const cl_map_item_t* const      p_item )
 {
         CL_ASSERT( p_item );
-        return( (cl_map_item_t*)p_item->pool_item.list_item.p_next );
+        return( (cl_map_item_t*)p_item->pool_item.list_item.p_next );
 }
 

PARAMETERS

@@ -686,13 +686,13 @@ Component Library: Quick Map/cl_qmap_next the quick map.

SEE ALSO

-
       Quick Map, cl_qmap_head, cl_qmap_tail, cl_qmap_prev, cl_qmap_end,
-       cl_map_item_t
+
       Quick Map, cl_qmap_head, cl_qmap_tail, cl_qmap_prev, cl_qmap_end,
+       cl_map_item_t
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_obj

[top][index]

@@ -705,7 +705,7 @@ Component Library: Quick Map/cl_qmap_obj

SYNOPSIS

CL_INLINE void* CL_API
 cl_qmap_obj(
-        IN      const cl_map_obj_t* const       p_map_obj )
+        IN      const cl_map_obj_t* const       p_map_obj )
 {
         CL_ASSERT( p_map_obj );
         return( (void*)p_map_obj->p_object );
@@ -719,12 +719,12 @@ Component Library: Quick Map/cl_qmap_obj
 
       Returns the value of the object pointer stored in the map object.
 

SEE ALSO

-
       Quick Map, cl_qmap_set_obj
+
       Quick Map, cl_qmap_set_obj
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_prev

[top][index]

@@ -736,12 +736,12 @@ Component Library: Quick Map/cl_qmap_prev

key value than a precified map item.

SYNOPSIS

-
CL_INLINE cl_map_item_t* CL_API
+
CL_INLINE cl_map_item_t* CL_API
 cl_qmap_prev(
-        IN      const cl_map_item_t* const      p_item )
+        IN      const cl_map_item_t* const      p_item )
 {
         CL_ASSERT( p_item );
-        return( (cl_map_item_t*)p_item->pool_item.list_item.p_prev );
+        return( (cl_map_item_t*)p_item->pool_item.list_item.p_prev );
 }
 

PARAMETERS

@@ -755,13 +755,13 @@ Component Library: Quick Map/cl_qmap_prev the quick map.

SEE ALSO

-
       Quick Map, cl_qmap_head, cl_qmap_tail, cl_qmap_next, cl_qmap_end,
-       cl_map_item_t
+
       Quick Map, cl_qmap_head, cl_qmap_tail, cl_qmap_next, cl_qmap_end,
+       cl_map_item_t
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_remove

[top][index]

@@ -773,14 +773,14 @@ Component Library: Quick Map/cl_qmap_remove

from a quick map.

SYNOPSIS

-
CL_EXPORT cl_map_item_t* CL_API
+
CL_EXPORT cl_map_item_t* CL_API
 cl_qmap_remove(
-        IN      cl_qmap_t* const        p_map,
+        IN      cl_qmap_t* const        p_map,
         IN      const uint64_t          key );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure from which to remove the item
+               [in] Pointer to a cl_qmap_t structure from which to remove the item
                with the specified key.
 
        key
@@ -793,12 +793,12 @@ Component Library: Quick Map/cl_qmap_remove
        quick map.
 

SEE ALSO

-
       Quick Map, cl_qmap_remove_item, cl_qmap_remove_all, cl_qmap_insert
+
       Quick Map, cl_qmap_remove_item, cl_qmap_remove_all, cl_qmap_insert
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_remove_all

[top][index]

@@ -812,7 +812,7 @@ Component Library: Quick Map/cl_qmap_remove_all

SYNOPSIS

CL_INLINE void CL_API
 cl_qmap_remove_all(
-        IN      cl_qmap_t* const        p_map )
+        IN      cl_qmap_t* const        p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -825,18 +825,18 @@ Component Library: Quick Map/cl_qmap_remove_all
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure to empty.
+               [in] Pointer to a cl_qmap_t structure to empty.
 
  RETURN VALUES
        This function does not return a value.
 

SEE ALSO

-
       Quick Map, cl_qmap_remove, cl_qmap_remove_item
+
       Quick Map, cl_qmap_remove, cl_qmap_remove_item
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_remove_item

[top][index]

@@ -850,8 +850,8 @@ Component Library: Quick Map/cl_qmap_remove_item

SYNOPSIS

CL_EXPORT void CL_API
 cl_qmap_remove_item(
-        IN      cl_qmap_t* const                p_map,
-        IN      cl_map_item_t* const    p_item );
+        IN      cl_qmap_t* const                p_map,
+        IN      cl_map_item_t* const    p_item );
 

PARAMETERS

       p_item
@@ -867,12 +867,12 @@ Component Library: Quick Map/cl_qmap_remove_item
 
       Removes the map item pointed to by p_item from its quick map.
 

SEE ALSO

-
       Quick Map, cl_qmap_remove, cl_qmap_remove_all, cl_qmap_insert
+
       Quick Map, cl_qmap_remove, cl_qmap_remove_all, cl_qmap_insert
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_set_obj

[top][index]

@@ -885,7 +885,7 @@ Component Library: Quick Map/cl_qmap_set_obj

SYNOPSIS

CL_INLINE void CL_API
 cl_qmap_set_obj(
-        IN      cl_map_obj_t* const     p_map_obj,
+        IN      cl_map_obj_t* const     p_map_obj,
         IN      const void* const       p_object )
 {
         CL_ASSERT( p_map_obj );
@@ -904,12 +904,12 @@ Component Library: Quick Map/cl_qmap_set_obj
 
       This function does not return a value.
 

SEE ALSO

-
       Quick Map, cl_qmap_obj
+
       Quick Map, cl_qmap_obj
 

-

[Structures] +

[Structures] Component Library: Quick Map/cl_qmap_t

[top][index]

@@ -925,8 +925,8 @@ Component Library: Quick Map/cl_qmap_t

SYNOPSIS

typedef struct _cl_qmap
 {
-        cl_map_item_t   root;
-        cl_map_item_t   nil;
+        cl_map_item_t   root;
+        cl_map_item_t   nil;
         cl_state_t              state;
         size_t                  count;
 
@@ -934,12 +934,12 @@ Component Library: Quick Map/cl_qmap_t
 

PARAMETERS

       root
-               Map item that serves as root of the map.  The root is set up to
+               Map item that serves as root of the map.  The root is set up to
                always have itself as parent.  The left pointer is set to point to
                the item at the root.
 
        nil
-               Map item that serves as terminator for all leaves, as well as providing
+               Map item that serves as terminator for all leaves, as well as providing
                the list item used as quick list for storing map items in a list for
                faster traversal.
 
@@ -950,12 +950,12 @@ Component Library: Quick Map/cl_qmap_t
                Number of items in the map.
 

SEE ALSO

-
       Quick Map
+
       Quick Map
 

-

[Functions] +

[Functions] Component Library: Quick Map/cl_qmap_tail

[top][index]

@@ -967,18 +967,18 @@ Component Library: Quick Map/cl_qmap_tail

value stored in a quick map.

SYNOPSIS

-
CL_INLINE cl_map_item_t* CL_API
+
CL_INLINE cl_map_item_t* CL_API
 cl_qmap_tail(
-        IN      const cl_qmap_t* const  p_map )
+        IN      const cl_qmap_t* const  p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
-        return( (cl_map_item_t*)p_map->nil.pool_item.list_item.p_prev );
+        return( (cl_map_item_t*)p_map->nil.pool_item.list_item.p_prev );
 }
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_qmap_t structure whose item with the highest key
+               [in] Pointer to a cl_qmap_t structure whose item with the highest key
                is returned.
 
  RETURN VALUES
@@ -987,10 +987,10 @@ Component Library: Quick Map/cl_qmap_tail
        Pointer to the map end if the quick map was empty.
 

NOTES

-
       cl_qmap_end does not remove the item from the map.
+
       cl_qmap_end does not remove the item from the map.
 

SEE ALSO

-
       Quick Map, cl_qmap_head, cl_qmap_next, cl_qmap_prev, cl_qmap_end,
+
       Quick Map, cl_qmap_head, cl_qmap_next, cl_qmap_prev, cl_qmap_end,
        cl_qmap_item_t
 
diff --git a/trunk/docs/complib/cl_qpool_h.html b/trunk/docs/complib/cl_qpool_h.html index 8bfab34a..660d8d32 100644 --- a/trunk/docs/complib/cl_qpool_h.html +++ b/trunk/docs/complib/cl_qpool_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_qpool_h.html +./inc_docs/complib/cl_qpool_h.html -Generated from ./inc/complib/cl_qpool.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_qpool.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Quick Pool

-

[top][index]

+

[top][parent][index]

NAME

       Quick Pool
 
@@ -31,35 +31,35 @@ Component Library/Quick Pool objects to the pool. The only method of returning memory to the system is to destroy the pool. - The quick pool operates on cl_pool_item_t structures that describe + The quick pool operates on cl_pool_item_t structures that describe objects. This can provides for more efficient memory use and operation. - If using a cl_pool_item_t is not desired, the Pool provides similar + If using a cl_pool_item_t is not desired, the Pool provides similar functionality but operates on opaque objects. - The quick pool functions operates on a cl_qpool_t structure which should + The quick pool functions operates on a cl_qpool_t structure which should be treated as opaque and should be manipulated only through the provided functions.

SEE ALSO

       Structures:
-               cl_qpool_t, cl_pool_item_t
+               cl_qpool_t, cl_pool_item_t
 
        Callbacks:
-               cl_pfn_qpool_init_t, cl_pfn_qpool_dtor_t
+               cl_pfn_qpool_init_t, cl_pfn_qpool_dtor_t
 
        Initialization/Destruction:
-               cl_qpool_construct, cl_qpool_init, cl_qpool_destroy
+               cl_qpool_construct, cl_qpool_init, cl_qpool_destroy
 
        Manipulation:
-               cl_qpool_get, cl_qpool_put, cl_qpool_put_list, cl_qpool_grow
+               cl_qpool_get, cl_qpool_put, cl_qpool_put_list, cl_qpool_grow
 
        Attributes:
-               cl_is_qpool_inited, cl_qpool_count
+               cl_is_qpool_inited, cl_qpool_count
 

-

[Functions] +

[Functions] Component Library: Quick Pool/cl_is_qpool_inited

[top][index]

@@ -73,16 +73,16 @@ Component Library: Quick Pool/cl_is_qpool_inited

SYNOPSIS

CL_INLINE uint32_t CL_API
 cl_is_qpool_inited(
-        IN      const cl_qpool_t* const p_pool )
+        IN      const cl_qpool_t* const p_pool )
 {
         /* CL_ASSERT that a non-null pointer is provided. */
         CL_ASSERT( p_pool );
-        return( cl_is_qcpool_inited( &p_pool->qcpool ) );
+        return( cl_is_qcpool_inited( &p_pool->qcpool ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qpool_t structure whose initialization state
+               [in] Pointer to a cl_qpool_t structure whose initialization state
                to check.
 
  RETURN VALUES
@@ -100,7 +100,7 @@ Component Library: Quick Pool/cl_is_qpool_inited
 
 
-

[Definitions] +

[Definitions] Component Library: Quick Pool/cl_pfn_qpool_dtor_t

[top][index]

@@ -115,15 +115,15 @@ Component Library: Quick Pool/cl_pfn_qpool_dtor_t

SYNOPSIS

typedef void
 (CL_API *cl_pfn_qpool_dtor_t)(
-        IN      const cl_pool_item_t* const     p_pool_item,
+        IN      const cl_pool_item_t* const     p_pool_item,
         IN      void*                                           context );
 

PARAMETERS

       p_pool_item
-               [in] Pointer to a cl_pool_item_t structure representing an object.
+               [in] Pointer to a cl_pool_item_t structure representing an object.
 
        context
-               [in] Context provided in a call to cl_qpool_init.
+               [in] Context provided in a call to cl_qpool_init.
 

RETURN VALUE

       This function does not return a value.
@@ -131,7 +131,7 @@ Component Library: Quick Pool/cl_pfn_qpool_dtor_t
 

NOTES

       This function type is provided as function prototype reference for
        the function provided by the user as an optional parameter to the
-       cl_qpool_init function.
+       cl_qpool_init function.
 
        The destructor is invoked once per allocated object, allowing the user
        to perform any necessary cleanup. Users should not attempt to deallocate
@@ -139,12 +139,12 @@ Component Library: Quick Pool/cl_pfn_qpool_dtor_t
        allocation and deallocation.
 

SEE ALSO

-
       Quick Pool, cl_qpool_init
+
       Quick Pool, cl_qpool_init
 

-

[Definitions] +

[Definitions] Component Library: Quick Pool/cl_pfn_qpool_init_t

[top][index]

@@ -157,55 +157,55 @@ Component Library: Quick Pool/cl_pfn_qpool_init_t

quick pool.

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_qpool_init_t)(
         IN      void* const                             p_object,
         IN      void*                                   context,
-        OUT     cl_pool_item_t** const  pp_pool_item );
+        OUT     cl_pool_item_t** const  pp_pool_item );
 

PARAMETERS

       p_object
                [in] Pointer to an object to initialize.
 
        context
-               [in] Context provided in a call to cl_qpool_init.
+               [in] Context provided in a call to cl_qpool_init.
 
  RETURN VALUES
        Return CL_SUCCESS to indicate that initialization of the object
        was successful and that initialization of further objects may continue.
 
-       Other cl_status_t values will be returned by cl_qcpool_init
-       and cl_qcpool_grow.
+       Other cl_status_t values will be returned by cl_qcpool_init
+       and cl_qcpool_grow.
 

NOTES

       This function type is provided as function prototype reference for
        the function provided by the user as an optional parameter to the
-       cl_qpool_init function.
+       cl_qpool_init function.
 
        The initializer is invoked once per allocated object, allowing the user
        to perform any necessary initialization.  Returning a status other than
-       CL_SUCCESS aborts a grow operation, initiated either through cl_qcpool_init
-       or cl_qcpool_grow, causing the initiating function to fail.
+       CL_SUCCESS aborts a grow operation, initiated either through cl_qcpool_init
+       or cl_qcpool_grow, causing the initiating function to fail.
        Any non-CL_SUCCESS status will be returned by the function that initiated
        the grow operation.
 
        All memory for the object is pre-allocated.  Users should include space in
-       their objects for the cl_pool_item_t structure that will represent the
+       their objects for the cl_pool_item_t structure that will represent the
        object to avoid having to allocate that structure in the initialization
        callback.
 
-       When later performing a cl_qcpool_get call, the return value is a pointer
-       to the cl_pool_item_t returned by this function in the pp_pool_item
+       When later performing a cl_qcpool_get call, the return value is a pointer
+       to the cl_pool_item_t returned by this function in the pp_pool_item
        parameter.  Users must set pp_pool_item to a valid pointer to the
-       cl_pool_item_t representing the object if they return CL_SUCCESS.
+       cl_pool_item_t representing the object if they return CL_SUCCESS.
 

SEE ALSO

-
       Quick Pool, cl_qpool_init
+
       Quick Pool, cl_qpool_init
 

-

[Functions] +

[Functions] Component Library: Quick Pool/cl_qpool_construct

[top][index]

@@ -218,28 +218,28 @@ Component Library: Quick Pool/cl_qpool_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_qpool_construct(
-        IN      cl_qpool_t* const       p_pool );
+        IN      cl_qpool_t* const       p_pool );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qpool_t structure whose state to initialize.
+               [in] Pointer to a cl_qpool_t structure whose state to initialize.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       Allows calling cl_qpool_init, cl_qpool_destroy, cl_is_qpool_inited.
+
       Allows calling cl_qpool_init, cl_qpool_destroy, cl_is_qpool_inited.
 
        Calling cl_qpool_construct is a prerequisite to calling any other
-       quick pool function except cl_pool_init.
+       quick pool function except cl_pool_init.
 

SEE ALSO

-
       Quick Pool, cl_qpool_init, cl_qpool_destroy, cl_is_qpool_inited.
+
       Quick Pool, cl_qpool_init, cl_qpool_destroy, cl_is_qpool_inited.
 

-

[Functions] +

[Functions] Component Library: Quick Pool/cl_qpool_count

[top][index]

@@ -253,15 +253,15 @@ Component Library: Quick Pool/cl_qpool_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_qpool_count(
-        IN      cl_qpool_t* const       p_pool )
+        IN      cl_qpool_t* const       p_pool )
 {
         CL_ASSERT( p_pool );
-        return( cl_qcpool_count( &p_pool->qcpool ) );
+        return( cl_qcpool_count( &p_pool->qcpool ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qpool_t structure for which the number of
+               [in] Pointer to a cl_qpool_t structure for which the number of
                available objects is requested.
 

RETURN VALUE

@@ -273,7 +273,7 @@ Component Library: Quick Pool/cl_qpool_count
-

[Functions] +

[Functions] Component Library: Quick Pool/cl_qpool_destroy

[top][index]

@@ -286,15 +286,15 @@ Component Library: Quick Pool/cl_qpool_destroy

SYNOPSIS

CL_INLINE void CL_API
 cl_qpool_destroy(
-        IN      cl_qpool_t* const       p_pool )
+        IN      cl_qpool_t* const       p_pool )
 {
         CL_ASSERT( p_pool );
-        cl_qcpool_destroy( &p_pool->qcpool );
+        cl_qcpool_destroy( &p_pool->qcpool );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qpool_t structure to destroy.
+               [in] Pointer to a cl_qpool_t structure to destroy.
 

RETURN VALUE

       This function does not return a value.
@@ -306,18 +306,18 @@ Component Library: Quick Pool/cl_qpool_destroy
        is invoked.
 
        This function should only be called after a call to
-       cl_qpool_construct or cl_qpool_init.
+       cl_qpool_construct or cl_qpool_init.
 
        In a debug build, cl_qpool_destroy asserts that all objects are in
        the pool.
 

SEE ALSO

-
       Quick Pool, cl_qpool_construct, cl_qpool_init
+
       Quick Pool, cl_qpool_construct, cl_qpool_init
 

-

[Functions] +

[Functions] Component Library: Quick Pool/cl_qpool_get

[top][index]

@@ -329,36 +329,36 @@ Component Library: Quick Pool/cl_qpool_get

quick pool.

SYNOPSIS

-
CL_INLINE cl_pool_item_t* CL_API
+
CL_INLINE cl_pool_item_t* CL_API
 cl_qpool_get(
-        IN      cl_qpool_t* const       p_pool )
+        IN      cl_qpool_t* const       p_pool )
 {
         CL_ASSERT( p_pool );
-        return( cl_qcpool_get( &p_pool->qcpool ) );
+        return( cl_qcpool_get( &p_pool->qcpool ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qpool_t structure from which to retrieve
+               [in] Pointer to a cl_qpool_t structure from which to retrieve
                an object.
 
  RETURN VALUES
-       Returns a pointer to a cl_pool_item_t for an object.
+       Returns a pointer to a cl_pool_item_t for an object.
 
        Returns NULL if the pool is empty and can not be grown automatically.
 

NOTES

       cl_qpool_get returns the object at the head of the pool. If the pool is
        empty, it is automatically grown to accommodate this request unless the
-       grow_size parameter passed to the cl_qpool_init function was zero.
+       grow_size parameter passed to the cl_qpool_init function was zero.
 

SEE ALSO

-
       Quick Pool, cl_qpool_get_tail, cl_qpool_put, cl_qpool_grow, cl_qpool_count
+
       Quick Pool, cl_qpool_get_tail, cl_qpool_put, cl_qpool_grow, cl_qpool_count
 

-

[Functions] +

[Functions] Component Library: Quick Pool/cl_qpool_grow

[top][index]

@@ -370,18 +370,18 @@ Component Library: Quick Pool/cl_qpool_grow

the specified number of objects.

SYNOPSIS

-
CL_INLINE cl_status_t CL_API
+
CL_INLINE cl_status_t CL_API
 cl_qpool_grow(
-        IN      cl_qpool_t* const       p_pool,
+        IN      cl_qpool_t* const       p_pool,
         IN      const size_t            obj_count )
 {
         CL_ASSERT( p_pool );
-        return( cl_qcpool_grow( &p_pool->qcpool, obj_count ) );
+        return( cl_qcpool_grow( &p_pool->qcpool, obj_count ) );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qpool_t structure whose capacity to grow.
+               [in] Pointer to a cl_qpool_t structure whose capacity to grow.
 
        obj_count
                [in] Number of objects by which to grow the pool.
@@ -392,9 +392,9 @@ Component Library: Quick Pool/cl_qpool_grow
        CL_INSUFFICIENT_MEMORY if there was not enough memory to grow the
        quick pool.
 
-       cl_status_t value returned by optional initialization callback function
+       cl_status_t value returned by optional initialization callback function
        specified by the pfn_initializer parameter passed to the
-       cl_qpool_init function.
+       cl_qpool_init function.
 

NOTES

       It is not necessary to call cl_qpool_grow if the pool is
@@ -406,7 +406,7 @@ Component Library: Quick Pool/cl_qpool_grow
 
 
-

[Functions] +

[Functions] Component Library: Quick Pool/cl_qpool_init

[top][index]

@@ -417,20 +417,20 @@ Component Library: Quick Pool/cl_qpool_init

       The cl_qpool_init function initializes a quick pool for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_qpool_init(
-        IN      cl_qpool_t* const               p_pool,
+        IN      cl_qpool_t* const               p_pool,
         IN      const size_t                    min_size,
         IN      const size_t                    max_size,
         IN      const size_t                    grow_size,
         IN      const size_t                    object_size,
-        IN      cl_pfn_qpool_init_t             pfn_initializer OPTIONAL,
-        IN      cl_pfn_qpool_dtor_t             pfn_destructor OPTIONAL,
+        IN      cl_pfn_qpool_init_t             pfn_initializer OPTIONAL,
+        IN      cl_pfn_qpool_dtor_t             pfn_destructor OPTIONAL,
         IN      const void* const               context );
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qpool_t structure to initialize.
+               [in] Pointer to a cl_qpool_t structure to initialize.
 
        min_size
                [in] Minimum number of objects that the pool should support. All
@@ -452,14 +452,14 @@ Component Library: Quick Pool/cl_qpool_init
        pfn_initializer
                [in] Initialization callback to invoke for every new object when
                growing the pool. This parameter is optional and may be NULL. If NULL,
-               the pool assumes the cl_pool_item_t structure describing objects is
-               located at the head of each object. See the cl_pfn_qpool_init_t
+               the pool assumes the cl_pool_item_t structure describing objects is
+               located at the head of each object. See the cl_pfn_qpool_init_t
                function type declaration for details about the callback function.
 
        pfn_destructor
                [in] Destructor callback to invoke for every object before memory for
                that object is freed. This parameter is optional and may be NULL.
-               See the cl_pfn_qpool_dtor_t function type declaration for details
+               See the cl_pfn_qpool_dtor_t function type declaration for details
                about the callback function.
 
        context
@@ -474,7 +474,7 @@ Component Library: Quick Pool/cl_qpool_init
        CL_INVALID_SETTING if a the maximum size is non-zero and less than the
        minimum size.
 
-       Other cl_status_t value returned by optional initialization callback function
+       Other cl_status_t value returned by optional initialization callback function
        specified by the pfn_initializer parameter.
 

NOTES

@@ -482,15 +482,15 @@ Component Library: Quick Pool/cl_qpool_init the capacity desired.

SEE ALSO

-
       Quick Pool, cl_qpool_construct, cl_qpool_destroy,
-       cl_qpool_get, cl_qpool_put, cl_qpool_grow,
-       cl_qpool_count, cl_pfn_qpool_init_t, cl_pfn_qpool_init_t,
-       cl_pfn_qpool_dtor_t
+
       Quick Pool, cl_qpool_construct, cl_qpool_destroy,
+       cl_qpool_get, cl_qpool_put, cl_qpool_grow,
+       cl_qpool_count, cl_pfn_qpool_init_t, cl_pfn_qpool_init_t,
+       cl_pfn_qpool_dtor_t
 

-

[Functions] +

[Functions] Component Library: Quick Pool/cl_qpool_put

[top][index]

@@ -503,20 +503,20 @@ Component Library: Quick Pool/cl_qpool_put

SYNOPSIS

CL_INLINE void CL_API
 cl_qpool_put(
-        IN      cl_qpool_t* const               p_pool,
-        IN      cl_pool_item_t* const   p_pool_item )
+        IN      cl_qpool_t* const               p_pool,
+        IN      cl_pool_item_t* const   p_pool_item )
 {
         CL_ASSERT( p_pool );
-        cl_qcpool_put( &p_pool->qcpool, p_pool_item );
+        cl_qcpool_put( &p_pool->qcpool, p_pool_item );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qpool_t structure to which to return
+               [in] Pointer to a cl_qpool_t structure to which to return
                an object.
 
        p_pool_item
-               [in] Pointer to a cl_pool_item_t structure for the object
+               [in] Pointer to a cl_pool_item_t structure for the object
                being returned.
 

RETURN VALUE

@@ -526,15 +526,15 @@ Component Library: Quick Pool/cl_qpool_put
       cl_qpool_put places the returned object at the head of the pool.
 
        The object specified by the p_pool_item parameter must have been
-       retrieved from the pool by a previous call to cl_qpool_get.
+       retrieved from the pool by a previous call to cl_qpool_get.
 

SEE ALSO

-
       Quick Pool, cl_qpool_put_tail, cl_qpool_get
+
       Quick Pool, cl_qpool_put_tail, cl_qpool_get
 

-

[Functions] +

[Functions] Component Library: Quick Pool/cl_qpool_put_list

[top][index]

@@ -548,20 +548,20 @@ Component Library: Quick Pool/cl_qpool_put_list

SYNOPSIS

CL_INLINE void CL_API
 cl_qpool_put_list(
-        IN      cl_qpool_t* const       p_pool,
-        IN      cl_qlist_t* const       p_list )
+        IN      cl_qpool_t* const       p_pool,
+        IN      cl_qlist_t* const       p_list )
 {
         CL_ASSERT( p_pool );
-        cl_qcpool_put_list( &p_pool->qcpool, p_list );
+        cl_qcpool_put_list( &p_pool->qcpool, p_list );
 }
 

PARAMETERS

       p_pool
-               [in] Pointer to a cl_qpool_t structure to which to return
+               [in] Pointer to a cl_qpool_t structure to which to return
                a list of objects.
 
        p_list
-               [in] Pointer to a cl_qlist_t structure for the list of objects
+               [in] Pointer to a cl_qlist_t structure for the list of objects
                being returned.
 

RETURN VALUE

@@ -571,15 +571,15 @@ Component Library: Quick Pool/cl_qpool_put_list
       cl_qpool_put_list places the returned objects at the head of the pool.
 
        The objects in the list specified by the p_list parameter must have been
-       retrieved from the pool by a previous call to cl_qpool_get.
+       retrieved from the pool by a previous call to cl_qpool_get.
 

SEE ALSO

-
       Quick Pool, cl_qpool_put, cl_qpool_put_tail, cl_qpool_get
+
       Quick Pool, cl_qpool_put, cl_qpool_put_tail, cl_qpool_get
 

-

[Structures] +

[Structures] Component Library: Quick Pool/cl_qpool_t

[top][index]

@@ -595,9 +595,9 @@ Component Library: Quick Pool/cl_qpool_t

SYNOPSIS

typedef struct _cl_qpool
 {
-        cl_qcpool_t                             qcpool;
-        cl_pfn_qpool_init_t             pfn_init;
-        cl_pfn_qpool_dtor_t             pfn_dtor;
+        cl_qcpool_t                             qcpool;
+        cl_pfn_qpool_init_t             pfn_init;
+        cl_pfn_qpool_dtor_t             pfn_dtor;
         const void                              *context;
 
 } cl_qpool_t;
diff --git a/trunk/docs/complib/cl_rbmap_h.html b/trunk/docs/complib/cl_rbmap_h.html
index b5965b4b..344b47b3 100644
--- a/trunk/docs/complib/cl_rbmap_h.html
+++ b/trunk/docs/complib/cl_rbmap_h.html
@@ -2,24 +2,24 @@
 
 
 
-./inc_doc/complib/cl_rbmap_h.html
+./inc_docs/complib/cl_rbmap_h.html
 
 
 
 
-Generated from ./inc/complib/cl_rbmap.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31
+Generated from ./inc/complib/cl_rbmap.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38
 

[Modules] Component Library/RB Map

-

[top][index]

+

[top][parent][index]

NAME

-
       RB Map
+
       RB Map
 

DESCRIPTION

-
       RB map implements a binary tree that stores user provided cl_rbmap_item_t
+
       RB map implements a binary tree that stores user provided cl_rbmap_item_t
        structures.  Each item stored in a RB map has a unique key
        (duplicates are not allowed).  RB map provides the ability to
        efficiently search for an item given a key.
@@ -31,34 +31,34 @@ Component Library/RB Map
        RB map is not thread safe, and users must provide serialization when
        adding and removing items from the map.
 
-       The RB map functions operate on a cl_rbmap_t structure which should be
+       The RB map functions operate on a cl_rbmap_t structure which should be
        treated as opaque and should be manipulated only through the provided
        functions.
 

SEE ALSO

       Structures:
-               cl_rbmap_t, cl_rbmap_item_t
+               cl_rbmap_t, cl_rbmap_item_t
 
        Initialization:
-               cl_rbmap_init
+               cl_rbmap_init
 
        Iteration:
-               cl_rbmap_root, cl_rbmap_end, cl_rbmap_left, cl_rbmap_right, cl_rbmap_up
+               cl_rbmap_root, cl_rbmap_end, cl_rbmap_left, cl_rbmap_right, cl_rbmap_up
 
        Manipulation:
-               cl_rbmap_insert, cl_rbmap_get, cl_rbmap_remove_item, cl_rbmap_remove,
-               cl_rbmap_reset, cl_rbmap_merge, cl_rbmap_delta
+               cl_rbmap_insert, cl_rbmap_get, cl_rbmap_remove_item, cl_rbmap_remove,
+               cl_rbmap_reset, cl_rbmap_merge, cl_rbmap_delta
 
        Search:
                cl_rbmap_apply_func
 
        Attributes:
-               cl_rbmap_count, cl_is_rbmap_empty,
+               cl_rbmap_count, cl_is_rbmap_empty,
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_is_rbmap_empty

[top][index]

@@ -71,7 +71,7 @@ Component Library: RB Map/cl_is_rbmap_empty

SYNOPSIS

CL_INLINE boolean_t CL_API
 cl_is_rbmap_empty(
-        IN      const cl_rbmap_t* const p_map )
+        IN      const cl_rbmap_t* const p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -81,7 +81,7 @@ Component Library: RB Map/cl_is_rbmap_empty
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_rbmap_t structure to test for emptiness.
+               [in] Pointer to a cl_rbmap_t structure to test for emptiness.
 
  RETURN VALUES
        TRUE if the RB map is empty.
@@ -89,12 +89,12 @@ Component Library: RB Map/cl_is_rbmap_empty
        FALSE otherwise.
 

SEE ALSO

-
       RB Map, cl_rbmap_count, cl_rbmap_reset
+
       RB Map, cl_rbmap_count, cl_rbmap_reset
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_rbmap_count

[top][index]

@@ -108,7 +108,7 @@ Component Library: RB Map/cl_rbmap_count

SYNOPSIS

CL_INLINE size_t CL_API
 cl_rbmap_count(
-        IN      const cl_rbmap_t* const p_map )
+        IN      const cl_rbmap_t* const p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -117,18 +117,18 @@ Component Library: RB Map/cl_rbmap_count
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_rbmap_t structure whose item count to return.
+               [in] Pointer to a cl_rbmap_t structure whose item count to return.
 

RETURN VALUE

       Returns the number of items stored in the map.
 

SEE ALSO

-
       RB Map, cl_is_rbmap_empty
+
       RB Map, cl_is_rbmap_empty
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_rbmap_end

[top][index]

@@ -139,9 +139,9 @@ Component Library: RB Map/cl_rbmap_end

       The cl_rbmap_end function returns the end of a RB map.
 

SYNOPSIS

-
CL_INLINE const cl_rbmap_item_t* const CL_API
+
CL_INLINE const cl_rbmap_item_t* const CL_API
 cl_rbmap_end(
-        IN      const cl_rbmap_t* const p_map )
+        IN      const cl_rbmap_t* const p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -151,7 +151,7 @@ Component Library: RB Map/cl_rbmap_end
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_rbmap_t structure whose end to return.
+               [in] Pointer to a cl_rbmap_t structure whose end to return.
 

RETURN VALUE

       Pointer to the end of the map.
@@ -165,13 +165,13 @@ Component Library: RB Map/cl_rbmap_end
        the map is empty.
 

SEE ALSO

-
       RB Map, cl_rbmap_head, cl_rbmap_tail, cl_rbmap_next, cl_rbmap_prev
-       cl_rbmap_root, cl_rbmap_left, cl_rbmap_right, cl_rbmap_up
+
       RB Map, cl_rbmap_head, cl_rbmap_tail, cl_rbmap_next, cl_rbmap_prev
+       cl_rbmap_root, cl_rbmap_left, cl_rbmap_right, cl_rbmap_up
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_rbmap_init

[top][index]

@@ -184,7 +184,7 @@ Component Library: RB Map/cl_rbmap_init

SYNOPSIS

CL_INLINE void CL_API
 cl_rbmap_init(
-        IN      cl_rbmap_t* const       p_map )
+        IN      cl_rbmap_t* const       p_map )
 {
         CL_ASSERT( p_map );
 
@@ -212,7 +212,7 @@ Component Library: RB Map/cl_rbmap_init
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_rbmap_t structure to initialize.
+               [in] Pointer to a cl_rbmap_t structure to initialize.
 
  RETURN VALUES
        This function does not return a value.
@@ -221,12 +221,12 @@ Component Library: RB Map/cl_rbmap_init
 
       Allows calling RB map manipulation functions.
 

SEE ALSO

-
       RB Map, cl_rbmap_insert, cl_rbmap_remove
+
       RB Map, cl_rbmap_insert, cl_rbmap_remove
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_rbmap_insert

[top][index]

@@ -239,21 +239,21 @@ Component Library: RB Map/cl_rbmap_insert

SYNOPSIS

CL_EXPORT void CL_API
 cl_rbmap_insert(
-        IN      cl_rbmap_t* const               p_map,
-        IN      cl_rbmap_item_t* const  p_insert_at,
-        IN      cl_rbmap_item_t* const  p_item,
+        IN      cl_rbmap_t* const               p_map,
+        IN      cl_rbmap_item_t* const  p_insert_at,
+        IN      cl_rbmap_item_t* const  p_item,
         IN      boolean_t                               left );
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_rbmap_t structure into which to add the item.
+               [in] Pointer to a cl_rbmap_t structure into which to add the item.
 
        p_insert_at
-               [in] Pointer to a cl_rbmap_item_t structure to serve as parent
+               [in] Pointer to a cl_rbmap_item_t structure to serve as parent
                to p_item.
 
        p_item
-               [in] Pointer to a cl_rbmap_item_t stucture to insert into the RB map.
+               [in] Pointer to a cl_rbmap_item_t stucture to insert into the RB map.
 
        left
                [in] Indicates that p_item should be inserted to the left of p_insert_at.
@@ -268,12 +268,12 @@ Component Library: RB Map/cl_rbmap_insert
 
       Insertion operations may cause the RB map to rebalance.
 

SEE ALSO

-
       RB Map, cl_rbmap_remove, cl_rbmap_item_t
+
       RB Map, cl_rbmap_remove, cl_rbmap_item_t
 

-

[Structures] +

[Structures] Component Library: RB Map/cl_rbmap_item_t

[top][index]

@@ -325,12 +325,12 @@ Component Library: RB Map/cl_rbmap_item_t

to be stored in a quick list, a quick pool, and a RB map.

SEE ALSO

-
       RB Map, cl_rbmap_insert, cl_rbmap_key, cl_pool_item_t, cl_list_item_t
+
       RB Map, cl_rbmap_insert, cl_rbmap_key, cl_pool_item_t, cl_list_item_t
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_rbmap_left

[top][index]

@@ -342,12 +342,12 @@ Component Library: RB Map/cl_rbmap_left

of the specified map item.

SYNOPSIS

-
CL_INLINE cl_rbmap_item_t* CL_API
+
CL_INLINE cl_rbmap_item_t* CL_API
 cl_rbmap_left(
-        IN      const cl_rbmap_item_t* const    p_item )
+        IN      const cl_rbmap_item_t* const    p_item )
 {
         CL_ASSERT( p_item );
-        return( (cl_rbmap_item_t*)p_item->p_left );
+        return( (cl_rbmap_item_t*)p_item->p_left );
 }
 

PARAMETERS

@@ -360,13 +360,13 @@ Component Library: RB Map/cl_rbmap_left Pointer to the map end if no item is to the left.

SEE ALSO

-
       RB Map, cl_rbmap_head, cl_rbmap_tail, cl_rbmap_next, cl_rbmap_end,
-       cl_rbmap_item_t
+
       RB Map, cl_rbmap_head, cl_rbmap_tail, cl_rbmap_next, cl_rbmap_end,
+       cl_rbmap_item_t
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_rbmap_remove_item

[top][index]

@@ -380,8 +380,8 @@ Component Library: RB Map/cl_rbmap_remove_item

SYNOPSIS

CL_EXPORT void CL_API
 cl_rbmap_remove_item(
-        IN      cl_rbmap_t* const               p_map,
-        IN      cl_rbmap_item_t* const  p_item );
+        IN      cl_rbmap_t* const               p_map,
+        IN      cl_rbmap_item_t* const  p_item );
 

PARAMETERS

       p_item
@@ -397,12 +397,12 @@ Component Library: RB Map/cl_rbmap_remove_item
 
       Removes the map item pointed to by p_item from its RB map.
 

SEE ALSO

-
       RB Map, cl_rbmap_remove, cl_rbmap_reset, cl_rbmap_insert
+
       RB Map, cl_rbmap_remove, cl_rbmap_reset, cl_rbmap_insert
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_rbmap_reset

[top][index]

@@ -416,7 +416,7 @@ Component Library: RB Map/cl_rbmap_reset

SYNOPSIS

CL_INLINE void CL_API
 cl_rbmap_reset(
-        IN      cl_rbmap_t* const       p_map )
+        IN      cl_rbmap_t* const       p_map )
 {
         CL_ASSERT( p_map );
         CL_ASSERT( p_map->state == CL_INITIALIZED );
@@ -427,18 +427,18 @@ Component Library: RB Map/cl_rbmap_reset
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_rbmap_t structure to empty.
+               [in] Pointer to a cl_rbmap_t structure to empty.
 
  RETURN VALUES
        This function does not return a value.
 

SEE ALSO

-
       RB Map, cl_rbmap_remove, cl_rbmap_remove_item
+
       RB Map, cl_rbmap_remove, cl_rbmap_remove_item
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_rbmap_right

[top][index]

@@ -450,12 +450,12 @@ Component Library: RB Map/cl_rbmap_right

of the specified map item.

SYNOPSIS

-
CL_INLINE cl_rbmap_item_t* CL_API
+
CL_INLINE cl_rbmap_item_t* CL_API
 cl_rbmap_right(
-        IN      const cl_rbmap_item_t* const    p_item )
+        IN      const cl_rbmap_item_t* const    p_item )
 {
         CL_ASSERT( p_item );
-        return( (cl_rbmap_item_t*)p_item->p_right );
+        return( (cl_rbmap_item_t*)p_item->p_right );
 }
 

PARAMETERS

@@ -468,13 +468,13 @@ Component Library: RB Map/cl_rbmap_right Pointer to the map end if no item is to the right.

SEE ALSO

-
       RB Map, cl_rbmap_head, cl_rbmap_tail, cl_rbmap_next, cl_rbmap_end,
-       cl_rbmap_item_t
+
       RB Map, cl_rbmap_head, cl_rbmap_tail, cl_rbmap_next, cl_rbmap_end,
+       cl_rbmap_item_t
 

-

[Functions] +

[Functions] Component Library: RB Map/cl_rbmap_root

[top][index]

@@ -485,9 +485,9 @@ Component Library: RB Map/cl_rbmap_root

       The cl_rbmap_root function returns the root of a RB map.
 

SYNOPSIS

-
CL_INLINE cl_rbmap_item_t* const CL_API
+
CL_INLINE cl_rbmap_item_t* const CL_API
 cl_rbmap_root(
-        IN      const cl_rbmap_t* const p_map )
+        IN      const cl_rbmap_t* const p_map )
 {
         CL_ASSERT( p_map );
         return( p_map->root.p_left );
@@ -495,13 +495,13 @@ Component Library: RB Map/cl_rbmap_root
 

PARAMETERS

       p_map
-               [in] Pointer to a cl_rbmap_t structure whose root to return.
+               [in] Pointer to a cl_rbmap_t structure whose root to return.
 

RETURN VALUE

       Pointer to the end of the map.
 

NOTES

-
       cl_rbmap_end is useful for determining the validity of map items returned
+
       cl_rbmap_end is useful for determining the validity of map items returned
        by cl_rbmap_head, cl_rbmap_tail, cl_rbmap_next, or cl_rbmap_prev.  If the map
        item pointer returned by any of these functions compares to the end, the
        end of the map was encoutered.
@@ -509,13 +509,13 @@ Component Library: RB Map/cl_rbmap_root
        the map is empty.
 

SEE ALSO

-
       RB Map, cl_rbmap_head, cl_rbmap_tail, cl_rbmap_next, cl_rbmap_prev,
-       cl_rbmap_end, cl_rbmap_left, cl_rbmap_right, cl_rbmap_up
+
       RB Map, cl_rbmap_head, cl_rbmap_tail, cl_rbmap_next, cl_rbmap_prev,
+       cl_rbmap_end, cl_rbmap_left, cl_rbmap_right, cl_rbmap_up
 

-

[Structures] +

[Structures] Component Library: RB Map/cl_rbmap_t

[top][index]

@@ -531,8 +531,8 @@ Component Library: RB Map/cl_rbmap_t

SYNOPSIS

typedef struct _cl_rbmap
 {
-        cl_rbmap_item_t root;
-        cl_rbmap_item_t nil;
+        cl_rbmap_item_t root;
+        cl_rbmap_item_t nil;
         cl_state_t              state;
         size_t                  count;
 
@@ -540,12 +540,12 @@ Component Library: RB Map/cl_rbmap_t
 

PARAMETERS

       root
-               Map item that serves as root of the map.  The root is set up to
+               Map item that serves as root of the map.  The root is set up to
                always have itself as parent.  The left pointer is set to point to
                the item at the root.
 
        nil
-               Map item that serves as terminator for all leaves, as well as providing
+               Map item that serves as terminator for all leaves, as well as providing
                the list item used as quick list for storing map items in a list for
                faster traversal.
 
@@ -556,7 +556,7 @@ Component Library: RB Map/cl_rbmap_t
                Number of items in the map.
 

SEE ALSO

-
       RB Map
+
       RB Map
 
diff --git a/trunk/docs/complib/cl_reqmgr_h.html b/trunk/docs/complib/cl_reqmgr_h.html index 39e313e1..97be0447 100644 --- a/trunk/docs/complib/cl_reqmgr_h.html +++ b/trunk/docs/complib/cl_reqmgr_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_reqmgr_h.html +./inc_docs/complib/cl_reqmgr_h.html -Generated from ./inc/complib/cl_reqmgr.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_reqmgr.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Request Manager

-

[top][index]

+

[top][parent][index]

NAME

       Request Manager
 
@@ -28,30 +28,30 @@ Component Library/Request Manager While the request manager manages synchronous and asynchronous requests for objects, it does not itself operate asynchronously. Instead, the - cl_req_mgr_resume function returns information for resuming asynchronous - requests. If a call to cl_req_mgr_resume returns CL_SUCCESS, additional + cl_req_mgr_resume function returns information for resuming asynchronous + requests. If a call to cl_req_mgr_resume returns CL_SUCCESS, additional requests may be able to resume. It is recommended that users flush - pending requests by calling cl_req_mgr_resume while CL_SUCCESS is returned. + pending requests by calling cl_req_mgr_resume while CL_SUCCESS is returned. - The request manager functions operates on a cl_req_mgr_t structure which + The request manager functions operates on a cl_req_mgr_t structure which should be treated as opaque and should be manipulated only through the provided functions.

SEE ALSO

       Types:
-               cl_req_type_t
+               cl_req_type_t
 
        Structures:
-               cl_req_mgr_t
+               cl_req_mgr_t
 
        Callbacks:
-               cl_pfn_req_cb_t, cl_pfn_reqmgr_get_count_t
+               cl_pfn_req_cb_t, cl_pfn_reqmgr_get_count_t
 
        Initialization/Destruction:
-               cl_req_mgr_construct, cl_req_mgr_init, cl_req_mgr_destroy
+               cl_req_mgr_construct, cl_req_mgr_init, cl_req_mgr_destroy
 
        Manipulation:
-               cl_req_mgr_get, cl_req_mgr_resume
+               cl_req_mgr_get, cl_req_mgr_resume
 
        Attributes:
                cl_is_req_mgr_inited, cl_req_mgr_count
@@ -59,7 +59,7 @@ Component Library/Request Manager
 
 
-

[Definitions] +

[Definitions] Component Library: Request Manager/cl_pfn_req_cb_t

[top][index]

@@ -87,12 +87,12 @@ Component Library: Request Manager/cl_pfn_req_cb_t

cast the function pointer to this type.

SEE ALSO

-
       Request Manager, cl_req_mgr_get, cl_req_mgr_resume
+
       Request Manager, cl_req_mgr_get, cl_req_mgr_resume
 

-

[Definitions] +

[Definitions] Component Library: Request Manager/cl_pfn_reqmgr_get_count_t

[top][index]

@@ -110,7 +110,7 @@ Component Library: Request Manager/cl_pfn_reqmgr_get_count_t

PARAMETERS

       Context
-               [in] Context provided in a call to cl_req_mgr_init by
+               [in] Context provided in a call to cl_req_mgr_init by
                the get_context parameter.
 

RETURN VALUE

@@ -119,17 +119,17 @@ Component Library: Request Manager/cl_pfn_reqmgr_get_count_t

NOTES

       This function type is provided as function prototype reference for the
-       function passed into cl_req_mgr_init. This function is invoked by the
+       function passed into cl_req_mgr_init. This function is invoked by the
        request manager when trying to fulfill requests for resources, either
-       through a call to cl_req_mgr_get or cl_req_mgr_resume.
+       through a call to cl_req_mgr_get or cl_req_mgr_resume.
 

SEE ALSO

-
       Request Manager, cl_req_mgr_init, cl_req_mgr_get, cl_req_mgr_resume
+
       Request Manager, cl_req_mgr_init, cl_req_mgr_get, cl_req_mgr_resume
 

-

[Functions] +

[Functions] Component Library: Request Manager/cl_req_mgr_construct

[top][index]

@@ -142,29 +142,29 @@ Component Library: Request Manager/cl_req_mgr_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_req_mgr_construct(
-        IN      cl_req_mgr_t* const     p_req_mgr );
+        IN      cl_req_mgr_t* const     p_req_mgr );
 

PARAMETERS

       p_req_mgr
-               [in] Pointer to a cl_req_mgr_t structure to construct.
+               [in] Pointer to a cl_req_mgr_t structure to construct.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       cl_req_mgr_construct allows calling cl_req_mgr_destroy without first
-       calling cl_req_mgr_init.
+
       cl_req_mgr_construct allows calling cl_req_mgr_destroy without first
+       calling cl_req_mgr_init.
 
        Calling cl_req_mgr_construct is a prerequisite to calling any other
-       request manager function except cl_req_mgr_init.
+       request manager function except cl_req_mgr_init.
 

SEE ALSO

-
       Request Manager, cl_req_mgr_init, cl_req_mgr_destroy
+
       Request Manager, cl_req_mgr_init, cl_req_mgr_destroy
 

-

[Functions] +

[Functions] Component Library: Request Manager/cl_req_mgr_destroy

[top][index]

@@ -177,11 +177,11 @@ Component Library: Request Manager/cl_req_mgr_destroy

SYNOPSIS

CL_EXPORT void CL_API
 cl_req_mgr_destroy(
-        IN      cl_req_mgr_t* const     p_req_mgr );
+        IN      cl_req_mgr_t* const     p_req_mgr );
 

PARAMETERS

       p_req_mgr
-               [in] Pointer to a cl_req_mgr_t structure to destroy.
+               [in] Pointer to a cl_req_mgr_t structure to destroy.
 

RETURN VALUE

       This function does not return a value.
@@ -190,16 +190,16 @@ Component Library: Request Manager/cl_req_mgr_destroy
 
       cl_req_mgr_destroy frees all memory allocated by the request manager.
        Further operations on the request manager should not be attempted.
 
-       This function should only be called after a call to cl_req_mgr_construct
-       or cl_req_mgr_init.
+       This function should only be called after a call to cl_req_mgr_construct
+       or cl_req_mgr_init.
 

SEE ALSO

-
       Request Manager, cl_req_mgr_construct, cl_req_mgr_init
+
       Request Manager, cl_req_mgr_construct, cl_req_mgr_init
 

-

[Functions] +

[Functions] Component Library: Request Manager/cl_req_mgr_get

[top][index]

@@ -211,18 +211,18 @@ Component Library: Request Manager/cl_req_mgr_get

requests for objects.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_req_mgr_get(
-        IN              cl_req_mgr_t* const     p_req_mgr,
+        IN              cl_req_mgr_t* const     p_req_mgr,
         IN OUT  size_t* const           p_count,
-        IN              const cl_req_type_t     req_type,
-        IN              cl_pfn_req_cb_t         pfn_callback,
+        IN              const cl_req_type_t     req_type,
+        IN              cl_pfn_req_cb_t         pfn_callback,
         IN              const void* const       context1,
         IN              const void* const       context2 );
 

PARAMETERS

       p_req_mgr
-               [in] Pointer to a cl_req_mgr_t structure from which to check
+               [in] Pointer to a cl_req_mgr_t structure from which to check
                for resources.
 
        p_count
@@ -272,16 +272,16 @@ Component Library: Request Manager/cl_req_mgr_get
        Asynchronous requests fail if there is insufficient system memory to
        queue them.
 
-       Once an asynchronous request is queued, use cl_req_mgr_resume to retrieve
+       Once an asynchronous request is queued, use cl_req_mgr_resume to retrieve
        information for resuming queued requests.
 

SEE ALSO

-
       Request Manager, cl_req_mgr_resume
+
       Request Manager, cl_req_mgr_resume
 

-

[Functions] +

[Functions] Component Library: Request Manager/cl_req_mgr_init

[top][index]

@@ -292,15 +292,15 @@ Component Library: Request Manager/cl_req_mgr_init

       The cl_req_mgr_init function initializes a request manager for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_req_mgr_init(
-        IN      cl_req_mgr_t* const                     p_req_mgr,
-        IN      cl_pfn_reqmgr_get_count_t       pfn_get_count,
+        IN      cl_req_mgr_t* const                     p_req_mgr,
+        IN      cl_pfn_reqmgr_get_count_t       pfn_get_count,
         IN      const void* const                       get_context );
 

PARAMETERS

       p_req_mgr
-               [in] Pointer to a cl_req_mgr_t structure to initialize.
+               [in] Pointer to a cl_req_mgr_t structure to initialize.
 
        pfn_get_count
                [in] Callback function invoked by the request manager to get the
@@ -320,13 +320,13 @@ Component Library: Request Manager/cl_req_mgr_init
        the request manager.
 

SEE ALSO

-
       Request Manager, cl_req_mgr_construct, cl_req_mgr_destroy, cl_req_mgr_get,
-       cl_req_mgr_resume, cl_pfn_req_mgr_get_count_t
+
       Request Manager, cl_req_mgr_construct, cl_req_mgr_destroy, cl_req_mgr_get,
+       cl_req_mgr_resume, cl_pfn_req_mgr_get_count_t
 

-

[Functions] +

[Functions] Component Library: Request Manager/cl_req_mgr_resume

[top][index]

@@ -337,32 +337,32 @@ Component Library: Request Manager/cl_req_mgr_resume

       The cl_req_mgr_resume function attempts to resume queued requests.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_req_mgr_resume(
-        IN      cl_req_mgr_t* const             p_req_mgr,
+        IN      cl_req_mgr_t* const             p_req_mgr,
         OUT     size_t* const                   p_count,
-        OUT     cl_pfn_req_cb_t* const  ppfn_callback,
+        OUT     cl_pfn_req_cb_t* const  ppfn_callback,
         OUT     const void** const              p_context1,
         OUT     const void** const              p_context2 );
 

PARAMETERS

       p_req_mgr
-               [in] Pointer to a cl_req_mgr_t structure from which to resume requests.
+               [in] Pointer to a cl_req_mgr_t structure from which to resume requests.
 
        p_count
                [out] Contains the number of objects available for a resuming request.
 
        ppfn_callback
                [out] Contains the pfn_callback value for the resuming request, as
-               provided to the call to the cl_req_mgr_get function.
+               provided to the call to the cl_req_mgr_get function.
 
        p_context1
                [out] Contains the context1 value for the resuming request, as provided
-               to the call to the cl_req_mgr_get function.
+               to the call to the cl_req_mgr_get function.
 
        p_context2
                [out] Contains the context2 value for the resuming request, as provided
-               to the call to the cl_req_mgr_get function.
+               to the call to the cl_req_mgr_get function.
 
  RETURN VALUES
        CL_SUCCESS if a request was completed.
@@ -379,12 +379,12 @@ Component Library: Request Manager/cl_req_mgr_resume
        able to be resumed if this call returns CL_SUCCESS.
 

SEE ALSO

-
       Request Manager, cl_req_mgr_get
+
       Request Manager, cl_req_mgr_get
 

-

[Structures] +

[Structures] Component Library: Request Manager/cl_req_mgr_t

[top][index]

@@ -400,10 +400,10 @@ Component Library: Request Manager/cl_req_mgr_t

SYNOPSIS

typedef struct _cl_req_mgr
 {
-        cl_pfn_reqmgr_get_count_t       pfn_get_count;
+        cl_pfn_reqmgr_get_count_t       pfn_get_count;
         const void                                      *get_context;
-        cl_qlist_t                                      request_queue;
-        cl_qpool_t                                      request_pool;
+        cl_qlist_t                                      request_queue;
+        cl_qpool_t                                      request_pool;
 
 } cl_req_mgr_t;
 
@@ -426,7 +426,7 @@ Component Library: Request Manager/cl_req_mgr_t

-

[Definitions] +

[Definitions] Component Library: Request Manager/cl_req_type_t

[top][index]

@@ -456,7 +456,7 @@ Component Library: Request Manager/cl_req_type_t

Asynchronous requests that may be broken into multiple smaller requests.

SEE ALSO

-
       Request Manager, cl_req_mgr_get
+
       Request Manager, cl_req_mgr_get
 
diff --git a/trunk/docs/complib/cl_spinlock_h.html b/trunk/docs/complib/cl_spinlock_h.html index deb389bc..2582f788 100644 --- a/trunk/docs/complib/cl_spinlock_h.html +++ b/trunk/docs/complib/cl_spinlock_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_spinlock_h.html +./inc_docs/complib/cl_spinlock_h.html -Generated from ./inc/complib/cl_spinlock.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_spinlock.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Spinlock

-

[top][index]

+

[top][parent][index]

NAME

       Spinlock
 
@@ -31,15 +31,15 @@ Component Library/Spinlock cl_spinlock_t Initialization: - cl_spinlock_construct, cl_spinlock_init, cl_spinlock_destroy + cl_spinlock_construct, cl_spinlock_init, cl_spinlock_destroy Manipulation - cl_spinlock_acquire, cl_spinlock_release + cl_spinlock_acquire, cl_spinlock_release

-

[Functions] +

[Functions] Component Library: Spinlock/cl_spinlock_acquire

[top][index]

@@ -65,12 +65,12 @@ Component Library: Spinlock/cl_spinlock_acquire

       This function does not return a value.
 

SEE ALSO

-
       Spinlock, cl_spinlock_release
+
       Spinlock, cl_spinlock_release
 

-

[Functions] +

[Functions] Component Library: Spinlock/cl_spinlock_construct

[top][index]

@@ -94,19 +94,19 @@ Component Library: Spinlock/cl_spinlock_construct

       This function does not return a value.
 

NOTES

-
       Allows calling cl_spinlock_destroy without first calling
-       cl_spinlock_init.
+
       Allows calling cl_spinlock_destroy without first calling
+       cl_spinlock_init.
 
        Calling cl_spinlock_construct is a prerequisite to calling any other
-       spin lock function except cl_spinlock_init.
+       spin lock function except cl_spinlock_init.
 

SEE ALSO

-
       Spinlock, cl_spinlock_init, cl_spinlock_destroy
+
       Spinlock, cl_spinlock_init, cl_spinlock_destroy
 

-

[Functions] +

[Functions] Component Library: Spinlock/cl_spinlock_destroy

[top][index]

@@ -131,16 +131,16 @@ Component Library: Spinlock/cl_spinlock_destroy

NOTES

       Performs any necessary cleanup of a spin lock. This function must only
-       be called if either cl_spinlock_construct or cl_spinlock_init has been
+       be called if either cl_spinlock_construct or cl_spinlock_init has been
        called.
 

SEE ALSO

-
       Spinlock, cl_spinlock_construct, cl_spinlock_init
+
       Spinlock, cl_spinlock_construct, cl_spinlock_init
 

-

[Functions] +

[Functions] Component Library: Spinlock/cl_spinlock_init

[top][index]

@@ -151,7 +151,7 @@ Component Library: Spinlock/cl_spinlock_init

       The cl_spinlock_init function initializes a spin lock for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_spinlock_init(
         IN      cl_spinlock_t* const    p_spinlock );
 
@@ -163,21 +163,21 @@ Component Library: Spinlock/cl_spinlock_init CL_SUCCESS if initialization succeeded. CL_ERROR if initialization failed. Callers should call - cl_spinlock_destroy to clean up any resources allocated during + cl_spinlock_destroy to clean up any resources allocated during initialization.

NOTES

       Initialize the spin lock structure. Allows calling cl_spinlock_aquire
-       and cl_spinlock_release.
+       and cl_spinlock_release.
 

SEE ALSO

-
       Spinlock, cl_spinlock_construct, cl_spinlock_destroy,
-       cl_spinlock_acquire, cl_spinlock_release
+
       Spinlock, cl_spinlock_construct, cl_spinlock_destroy,
+       cl_spinlock_acquire, cl_spinlock_release
 

-

[Functions] +

[Functions] Component Library: Spinlock/cl_spinlock_release

[top][index]

@@ -200,10 +200,10 @@ Component Library: Spinlock/cl_spinlock_release

       This function does not return a value.
 

NOTES

-
       Releases a spin lock after a call to cl_spinlock_acquire.
+
       Releases a spin lock after a call to cl_spinlock_acquire.
 

SEE ALSO

-
       Spinlock, cl_spinlock_acquire
+
       Spinlock, cl_spinlock_acquire
 
diff --git a/trunk/docs/complib/cl_syscallback_h.html b/trunk/docs/complib/cl_syscallback_h.html index ec2209d0..481edee1 100644 --- a/trunk/docs/complib/cl_syscallback_h.html +++ b/trunk/docs/complib/cl_syscallback_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_syscallback_h.html +./inc_docs/complib/cl_syscallback_h.html -Generated from ./inc/complib/cl_syscallback.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_syscallback.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/System Callback

-

[top][index]

+

[top][parent][index]

NAME

       System Callback
 
@@ -24,7 +24,7 @@ Component Library/System Callback Callbacks can be queued in a low- or high-priority queue for processing. - cl_thread_suspend and cl_thread_stall can be used to delay or stall the + cl_thread_suspend and cl_thread_stall can be used to delay or stall the callback thread. Environments that do not have a native system thread-pool emulate this @@ -36,7 +36,7 @@ Component Library/System Callback

-

[Functions] +

[Functions] Component Library: System Callback/cl_is_sys_callback_inited

[top][index]

@@ -66,7 +66,7 @@ __cl_is_sys_callback_inited( void );
-

[Definitions] +

[Definitions] Component Library: System Callback/cl_pfn_sys_callback_t

[top][index]

@@ -86,11 +86,11 @@ Component Library: System Callback/cl_pfn_sys_callback_t

PARAMETERS

       get_context
                [in] Value of the get_context parameter specified in a call
-               to cl_sys_callback_get.
+               to cl_sys_callback_get.
 
        queue_context
                [in] Value of the queue_context parameter specified in a call
-               to cl_sys_callback_queue.
+               to cl_sys_callback_queue.
 

RETURN VALUE

       This function does not return a value.
@@ -98,15 +98,15 @@ Component Library: System Callback/cl_pfn_sys_callback_t
 

NOTES

       This function type is provided as function prototype reference for
        the function provided by users as a parameter to the
-       cl_sys_callback_queue function.
+       cl_sys_callback_queue function.
 

SEE ALSO

-
       System Callback, cl_sys_callback_queue
+
       System Callback, cl_sys_callback_queue
 

-

[Functions] +

[Functions] Component Library: System Callback/cl_sys_callback_get

[top][index]

@@ -131,10 +131,10 @@ Component Library: System Callback/cl_sys_callback_get

Returns NULL if the call fails.

NOTES

-
       A system callback item must be released with a call to cl_sys_callback_put.
+
       A system callback item must be released with a call to cl_sys_callback_put.
 
        Care must be taken to prevent a system callback item from being returned
-       to the pool while it is queued. Callers of cl_sys_callback_queue must not
+       to the pool while it is queued. Callers of cl_sys_callback_queue must not
        return the system callback item to the pool until their callback has been
        invoked.
 
@@ -147,7 +147,7 @@ Component Library: System Callback/cl_sys_callback_get
 
 
-

[Functions] +

[Functions] Component Library: System Callback/cl_sys_callback_put

[top][index]

@@ -172,19 +172,19 @@ Component Library: System Callback/cl_sys_callback_put

NOTES

       The p_item parameter points to a system callback item returned by
-       a previous call to cl_sys_callback_get.
+       a previous call to cl_sys_callback_get.
 
        The specified system callback item must not be queued when making
        a call to this function.  This function can, however, be called
        from the callback function.
 

SEE ALSO

-
       System Callback, cl_sys_callback_get, cl_sys_callback_queue
+
       System Callback, cl_sys_callback_get, cl_sys_callback_queue
 

-

[Functions] +

[Functions] Component Library: System Callback/cl_sys_callback_queue

[top][index]

@@ -196,10 +196,10 @@ Component Library: System Callback/cl_sys_callback_queue

for execution.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_sys_callback_queue(
         IN      cl_sys_callback_item_t* const   p_item,
-        IN      cl_pfn_sys_callback_t                   pfn_callback,
+        IN      cl_pfn_sys_callback_t                   pfn_callback,
         IN      const void* const                               queue_context,
         IN      const boolean_t                                 high_priority );
 
@@ -209,7 +209,7 @@ Component Library: System Callback/cl_sys_callback_queue pfn_callback [in] Pointer to a function to be invoked by the system callback module. - See the cl_pfn_sys_callback_t function type definition for details + See the cl_pfn_sys_callback_t function type definition for details about the callback function. queue_context @@ -227,7 +227,7 @@ Component Library: System Callback/cl_sys_callback_queue

NOTES

       A thread from the system thread pool will invoke the specified callback
        function with the get_context value specified in the call to
-       cl_sys_callback_get and the specified context as parameters.
+       cl_sys_callback_get and the specified context as parameters.
 
        The high priority queue is processed before the low priority queue. There
        is no fairness algorithm implemented for removing items from the queues.
@@ -236,7 +236,7 @@ Component Library: System Callback/cl_sys_callback_queue
        at a time.
 

SEE ALSO

-
       System Callback, cl_sys_callback_get, cl_pfn_sys_callback_t
+
       System Callback, cl_sys_callback_get, cl_pfn_sys_callback_t
 
diff --git a/trunk/docs/complib/cl_thread_h.html b/trunk/docs/complib/cl_thread_h.html index a837e85a..ab3ba4d6 100644 --- a/trunk/docs/complib/cl_thread_h.html +++ b/trunk/docs/complib/cl_thread_h.html @@ -2,16 +2,16 @@ -./inc_doc/complib/cl_thread_h.html +./inc_docs/complib/cl_thread_h.html -Generated from ./inc/complib/cl_thread.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_thread.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Functions] +

[Functions] Component Library: Thread/cl_is_blockable

[top][index]

@@ -38,7 +38,7 @@ Component Library: Thread/cl_is_blockable


-

[Definitions] +

[Definitions] Component Library: Thread/cl_pfn_thread_callback_t

[top][index]

@@ -73,7 +73,7 @@ Component Library: Thread/cl_pfn_thread_callback_t


-

[Functions] +

[Functions] Component Library: Thread/cl_proc_count

[top][index]

@@ -93,7 +93,7 @@ Component Library: Thread/cl_proc_count


-

[Functions] +

[Functions] Component Library: Thread/cl_thread_stall

[top][index]

@@ -120,15 +120,15 @@ Component Library: Thread/cl_thread_stall

       The cl_thread_stall function performs a busy wait for the specified
        number of microseconds. Care should be taken when using this function as
        it does not relinquish its quantum of operation. For longer wait
-       operations, users should call cl_thread_suspend if possible.
+       operations, users should call cl_thread_suspend if possible.
 

SEE ALSO

-
       Thread, cl_thread_suspend
+
       Thread, cl_thread_suspend
 

-

[Functions] +

[Functions] Component Library: Thread/cl_thread_suspend

[top][index]

@@ -154,10 +154,10 @@ Component Library: Thread/cl_thread_suspend

NOTES

       This function should only be called if it is valid for the caller's thread
        to enter a wait state. For stalling a thread that cannot enter a wait
-       state, callers should use cl_thread_stall.
+       state, callers should use cl_thread_stall.
 

SEE ALSO

-
       Thread, cl_thread_stall
+
       Thread, cl_thread_stall
 
diff --git a/trunk/docs/complib/cl_threadpool_h.html b/trunk/docs/complib/cl_threadpool_h.html index dc46d961..29f8ef47 100644 --- a/trunk/docs/complib/cl_threadpool_h.html +++ b/trunk/docs/complib/cl_threadpool_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_threadpool_h.html +./inc_docs/complib/cl_threadpool_h.html -Generated from ./inc/complib/cl_threadpool.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_threadpool.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Thread Pool

-

[top][index]

+

[top][parent][index]

NAME

       Thread Pool
 
@@ -25,24 +25,24 @@ Component Library/Thread Pool invoking a user specified callback function. All threads in the thread pool invoke the same callback function. - The thread pool functions operate on a cl_thread_pool_t structure which + The thread pool functions operate on a cl_thread_pool_t structure which should be treated as opaque, and should be manipulated only through the provided functions.

SEE ALSO

       Structures:
-               cl_thread_pool_t
+               cl_thread_pool_t
 
        Initialization:
-               cl_thread_pool_construct, cl_thread_pool_init, cl_thread_pool_destroy
+               cl_thread_pool_construct, cl_thread_pool_init, cl_thread_pool_destroy
 
        Manipulation
-               cl_thread_pool_signal
+               cl_thread_pool_signal
 

-

[Functions] +

[Functions] Component Library: Thread Pool/cl_thread_pool_construct

[top][index]

@@ -56,7 +56,7 @@ Component Library: Thread Pool/cl_thread_pool_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_thread_pool_construct(
-        IN      cl_thread_pool_t* const p_thread_pool );
+        IN      cl_thread_pool_t* const p_thread_pool );
 

PARAMETERS

       p_thread_pool
@@ -66,19 +66,19 @@ Component Library: Thread Pool/cl_thread_pool_construct
 
       This function does not return a value.
 

NOTES

-
       Allows calling cl_thread_pool_destroy without first calling
-       cl_thread_pool_init.
+
       Allows calling cl_thread_pool_destroy without first calling
+       cl_thread_pool_init.
 
        Calling cl_thread_pool_construct is a prerequisite to calling any other
-       thread pool function except cl_thread_pool_init.
+       thread pool function except cl_thread_pool_init.
 

SEE ALSO

-
       Thread Pool, cl_thread_pool_init, cl_thread_pool_destroy
+
       Thread Pool, cl_thread_pool_init, cl_thread_pool_destroy
 

-

[Functions] +

[Functions] Component Library: Thread Pool/cl_thread_pool_destroy

[top][index]

@@ -92,7 +92,7 @@ Component Library: Thread Pool/cl_thread_pool_destroy

SYNOPSIS

CL_EXPORT void CL_API
 cl_thread_pool_destroy(
-        IN      cl_thread_pool_t* const p_thread_pool );
+        IN      cl_thread_pool_t* const p_thread_pool );
 

PARAMETERS

       p_thread_pool
@@ -108,15 +108,15 @@ Component Library: Thread Pool/cl_thread_pool_destroy
        state is valid from the calling thread context.
 
        This function should only be called after a call to
-       cl_thread_pool_construct or cl_thread_pool_init.
+       cl_thread_pool_construct or cl_thread_pool_init.
 

SEE ALSO

-
       Thread Pool, cl_thread_pool_construct, cl_thread_pool_init
+
       Thread Pool, cl_thread_pool_construct, cl_thread_pool_init
 

-

[Functions] +

[Functions] Component Library: Thread Pool/cl_thread_pool_init

[top][index]

@@ -128,11 +128,11 @@ Component Library: Thread Pool/cl_thread_pool_init

managed by a thread pool.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_thread_pool_init(
-        IN      cl_thread_pool_t* const         p_thread_pool,
+        IN      cl_thread_pool_t* const         p_thread_pool,
         IN      uint32_t                                        thread_count,
-        IN      cl_pfn_thread_callback_t        pfn_callback,
+        IN      cl_pfn_thread_callback_t        pfn_callback,
         IN      const void* const                       context,
         IN      const char* const                       name );
 
@@ -145,7 +145,7 @@ Component Library: Thread Pool/cl_thread_pool_init pfn_callback [in] Address of a function to be invoked by a thread. - See the cl_pfn_thread_callback_t function type definition for + See the cl_pfn_thread_callback_t function type definition for details about the callback function. context @@ -170,13 +170,13 @@ Component Library: Thread Pool/cl_thread_pool_init are processors in the system.

SEE ALSO

-
       Thread Pool, cl_thread_pool_construct, cl_thread_pool_destroy,
-       cl_thread_pool_signal, cl_pfn_thread_callback_t
+
       Thread Pool, cl_thread_pool_construct, cl_thread_pool_destroy,
+       cl_thread_pool_signal, cl_pfn_thread_callback_t
 

-

[Functions] +

[Functions] Component Library: Thread Pool/cl_thread_pool_signal

[top][index]

@@ -188,9 +188,9 @@ Component Library: Thread Pool/cl_thread_pool_signal

the thread pool to invoke the thread poolÂ’s callback function.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_thread_pool_signal(
-        IN      cl_thread_pool_t* const p_thread_pool );
+        IN      cl_thread_pool_t* const p_thread_pool );
 

PARAMETERS

       p_thread_pool
@@ -213,7 +213,7 @@ Component Library: Thread Pool/cl_thread_pool_signal
 
 
-

[Structures] +

[Structures] Component Library: Thread Pool/cl_thread_pool_t

[top][index]

@@ -229,9 +229,9 @@ Component Library: Thread Pool/cl_thread_pool_t

SYNOPSIS

typedef struct _cl_thread_pool
 {
-        cl_pfn_thread_callback_t        pfn_callback;
+        cl_pfn_thread_callback_t        pfn_callback;
         const void                                      *context;
-        cl_list_t                                       thread_list;
+        cl_list_t                                       thread_list;
         cl_event_t                                      wakeup_event;
         cl_event_t                                      destroy_event;
         boolean_t                                       exit;
@@ -248,13 +248,13 @@ Component Library: Thread Pool/cl_thread_pool_t
                Context to pass to the thread callback function.
 
        thread_list
-               List of threads managed by the thread pool.
+               List of threads managed by the thread pool.
 
        event
-               Event used to signal threads to wake up and do work.
+               Event used to signal threads to wake up and do work.
 
        destroy_event
-               Event used to signal threads to exit.
+               Event used to signal threads to exit.
 
        exit
                Flag used to indicates threads to exit.
diff --git a/trunk/docs/complib/cl_timer_h.html b/trunk/docs/complib/cl_timer_h.html
index 1941589e..a0b6a72b 100644
--- a/trunk/docs/complib/cl_timer_h.html
+++ b/trunk/docs/complib/cl_timer_h.html
@@ -2,19 +2,19 @@
 
 
 
-./inc_doc/complib/cl_timer_h.html
+./inc_docs/complib/cl_timer_h.html
 
 
 
 
-Generated from ./inc/complib/cl_timer.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31
+Generated from ./inc/complib/cl_timer.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38
 

[Modules] Component Library/Timer

-

[top][index]

+

[top][parent][index]

NAME

       Timer
 
@@ -33,18 +33,18 @@ Component Library/Timer cl_timer_t Callbacks: - cl_pfn_timer_callback_t + cl_pfn_timer_callback_t Initialization: - cl_timer_construct, cl_timer_init, cl_timer_destroy + cl_timer_construct, cl_timer_init, cl_timer_destroy Manipulation: - cl_timer_start, cl_timer_stop + cl_timer_start, cl_timer_stop

-

[Functions] +

[Functions] Component Library: Time Stamp/cl_get_tick_count

[top][index]

@@ -63,12 +63,12 @@ Component Library: Time Stamp/cl_get_tick_count

       Value of the high-resolution performance counter.
 

SEE ALSO

-
       Timer, cl_get_time_stamp, cl_get_tick_freq
+
       Timer, cl_get_time_stamp, cl_get_tick_freq
 

-

[Functions] +

[Functions] Component Library: Time Stamp/cl_get_tick_freq

[top][index]

@@ -87,12 +87,12 @@ Component Library: Time Stamp/cl_get_tick_freq

       The frequency of the high-resolution performance counter.
 

SEE ALSO

-
       Timer, cl_get_time_stamp, cl_get_tick_count
+
       Timer, cl_get_time_stamp, cl_get_tick_count
 

-

[Functions] +

[Functions] Component Library: Time Stamp/cl_get_time_stamp

[top][index]

@@ -111,12 +111,12 @@ Component Library: Time Stamp/cl_get_time_stamp

       Time elapsed, in microseconds, since the system was booted.
 

SEE ALSO

-
       Timer, cl_get_time_stamp_usec, cl_get_time_stamp_sec
+
       Timer, cl_get_time_stamp_usec, cl_get_time_stamp_sec
 

-

[Functions] +

[Functions] Component Library: Time Stamp/cl_get_time_stamp_sec

[top][index]

@@ -135,12 +135,12 @@ Component Library: Time Stamp/cl_get_time_stamp_sec

       Time elapsed, in seconds, since the system was booted.
 

SEE ALSO

-
       Timer, cl_get_time_stamp
+
       Timer, cl_get_time_stamp
 

-

[Functions] +

[Functions] Component Library: Time Stamp/cl_get_time_stamp_usec

[top][index]

@@ -155,19 +155,19 @@ Component Library: Time Stamp/cl_get_time_stamp_usec

CL_INLINE uint64_t CL_API
 cl_get_time_stamp_usec( void )
 {
-        return cl_get_time_stamp();
+        return cl_get_time_stamp();
 }
 

RETURN VALUE

       Time elapsed, in microseconds, since the system was booted.
 

SEE ALSO

-
       Timer, cl_get_time_stamp, cl_get_time_stamp_sec
+
       Timer, cl_get_time_stamp, cl_get_time_stamp_sec
 

-

[Definitions] +

[Definitions] Component Library: Timer/cl_pfn_timer_callback_t

[top][index]

@@ -185,22 +185,22 @@ Component Library: Timer/cl_pfn_timer_callback_t

PARAMETERS

       context
-               [in] Value specified in a previous call to cl_timer_init.
+               [in] Value specified in a previous call to cl_timer_init.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_timer_init function.
+       function provided by users as a parameter to the cl_timer_init function.
 

SEE ALSO

-
       Timer, cl_timer_init
+
       Timer, cl_timer_init
 

-

[Functions] +

[Functions] Component Library: Timer/cl_timer_construct

[top][index]

@@ -223,18 +223,18 @@ Component Library: Timer/cl_timer_construct

       This function does not return a value.
 

NOTES

-
       Allows calling cl_timer_destroy without first calling cl_timer_init.
+
       Allows calling cl_timer_destroy without first calling cl_timer_init.
 
        Calling cl_timer_construct is a prerequisite to calling any other
-       timer function except cl_timer_init.
+       timer function except cl_timer_init.
 

SEE ALSO

-
       Timer, cl_timer_init, cl_timer_destroy
+
       Timer, cl_timer_init, cl_timer_destroy
 

-

[Functions] +

[Functions] Component Library: Timer/cl_timer_destroy

[top][index]

@@ -259,16 +259,16 @@ Component Library: Timer/cl_timer_destroy

NOTES

       cl_timer_destroy cancels any pending callbacks.
 
-       This function should only be called after a call to cl_timer_construct
-       or cl_timer_init.
+       This function should only be called after a call to cl_timer_construct
+       or cl_timer_init.
 

SEE ALSO

-
       Timer, cl_timer_construct, cl_timer_init
+
       Timer, cl_timer_construct, cl_timer_init
 

-

[Functions] +

[Functions] Component Library: Timer/cl_timer_init

[top][index]

@@ -279,10 +279,10 @@ Component Library: Timer/cl_timer_init

       The cl_timer_init function initializes a timer for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_timer_init(
         IN      cl_timer_t* const               p_timer,
-        IN      cl_pfn_timer_callback_t pfn_callback,
+        IN      cl_pfn_timer_callback_t pfn_callback,
         IN      const void* const               context );
 

PARAMETERS

@@ -291,7 +291,7 @@ Component Library: Timer/cl_timer_init pfn_callback [in] Address of a callback function to be invoked when a timer expires. - See the cl_pfn_timer_callback_t function type definition for details + See the cl_pfn_timer_callback_t function type definition for details about the callback function. context @@ -303,16 +303,16 @@ Component Library: Timer/cl_timer_init CL_ERROR otherwise.

NOTES

-
       Allows calling cl_timer_start and cl_timer_stop.
+
       Allows calling cl_timer_start and cl_timer_stop.
 

SEE ALSO

-
       Timer, cl_timer_construct, cl_timer_destroy, cl_timer_start,
-       cl_timer_stop, cl_pfn_timer_callback_t
+
       Timer, cl_timer_construct, cl_timer_destroy, cl_timer_start,
+       cl_timer_stop, cl_pfn_timer_callback_t
 

-

[Functions] +

[Functions] Component Library: Timer/cl_timer_start

[top][index]

@@ -323,7 +323,7 @@ Component Library: Timer/cl_timer_start

       The cl_timer_start function sets a timer to expire after a given interval.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_timer_start(
         IN      cl_timer_t* const       p_timer,
         IN      const uint32_t          time_ms );
@@ -348,12 +348,12 @@ Component Library: Timer/cl_timer_start
        may take longer to expire.
 

SEE ALSO

-
       Timer, cl_timer_stop, cl_timer_trim
+
       Timer, cl_timer_stop, cl_timer_trim
 

-

[Functions] +

[Functions] Component Library: Timer/cl_timer_stop

[top][index]

@@ -376,12 +376,12 @@ Component Library: Timer/cl_timer_stop

       This function does not return a value.
 

SEE ALSO

-
       Timer, cl_timer_start, cl_timer_trim
+
       Timer, cl_timer_start, cl_timer_trim
 

-

[Functions] +

[Functions] Component Library: Timer/cl_timer_trim

[top][index]

@@ -397,7 +397,7 @@ Component Library: Timer/cl_timer_trim

interval if that interval is less than the current timer expiration.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_timer_trim(
         IN      cl_timer_t* const       p_timer,
         IN      const uint32_t          time_ms );
@@ -425,7 +425,7 @@ Component Library: Timer/cl_timer_trim
        new interval, but may take longer to expire.
 

SEE ALSO

-
       Timer, cl_timer_start, cl_timer_stop
+
       Timer, cl_timer_start, cl_timer_stop
 
diff --git a/trunk/docs/complib/cl_types_h.html b/trunk/docs/complib/cl_types_h.html index 22aef497..5c7a80da 100644 --- a/trunk/docs/complib/cl_types_h.html +++ b/trunk/docs/complib/cl_types_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_types_h.html +./inc_docs/complib/cl_types_h.html -Generated from ./inc/complib/cl_types.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_types.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Definitions] +

[Definitions] Component Library/Data Types

-

[top][index]

+

[top][parent][index]

NAME

       Data Types
 
@@ -79,12 +79,12 @@ Component Library/Data Types


-

[Definitions] +

[Definitions] Component Library/Object States

-

[top][index]

+

[top][parent][index]

NAME

-
       Object States
+
       Object States
 

DESCRIPTION

       The object states enumerated type defines the valid states of components.
@@ -117,10 +117,10 @@ Component Library/Object States


-

[Definitions] +

[Definitions] Component Library/Parameter Keywords

-

[top][index]

+

[top][parent][index]

NAME

       Parameter Keywords
 
@@ -154,7 +154,7 @@ Component Library/Parameter Keywords


-

[Definitions] +

[Definitions] Component Library: Data Types/CL_STATUS_MSG

[top][index]

@@ -163,33 +163,33 @@ Component Library: Data Types/CL_STATUS_MSG

DESCRIPTION

       The CL_STATUS_MSG macro returns a textual representation of
-       an cl_status_t code.
+       an cl_status_t code.
 

SYNOPSIS

*       const char*
 *       CL_STATUS_MSG(
-*               IN cl_status_t errcode );
+*               IN cl_status_t errcode );
 

PARAMETERS

       errcode
-               [in] cl_status_t code for which to return a text representation.
+               [in] cl_status_t code for which to return a text representation.
 

RETURN VALUE

       Pointer to a string containing a textual representation of the errcode
        parameter.
 

NOTES

-
       This function performs boundary checking on the cl_status_t value,
+
       This function performs boundary checking on the cl_status_t value,
        masking off the upper 24-bits. If the value is out of bounds, the string
        "invalid status code" is returned.
 

SEE ALSO

-
       cl_status_t
+
       cl_status_t
 

-

[Definitions] +

[Definitions] Component Library: Data Types/cl_status_t

[top][index]

@@ -231,12 +231,12 @@ Component Library: Data Types/cl_status_t

} cl_status_t;

SEE ALSO

-
       Data Types, CL_STATUS_MSG
+
       Data Types, CL_STATUS_MSG
 

-

[Functions] +

[Functions] Component Library: Error Trapping/cl_panic

[top][index]

@@ -273,7 +273,7 @@ Component Library: Error Trapping/cl_panic


-

[Definitions] +

[Definitions] Component Library: Object States/cl_is_state_valid

[top][index]

@@ -307,12 +307,12 @@ Component Library: Object States/cl_is_state_valid

state to have an invalid value.

SEE ALSO

-
       Object States
+
       Object States
 

-

[Definitions] +

[Definitions] Component Library: Pointer Manipulation/offsetof

[top][index]

@@ -341,12 +341,12 @@ Component Library: Pointer Manipulation/offsetof

specified member.

SEE ALSO

-
       PARENT_STRUCT
+
       PARENT_STRUCT
 

-

[Definitions] +

[Definitions] Component Library: Pointer Manipulation/PARENT_STRUCT

[top][index]

@@ -380,12 +380,12 @@ Component Library: Pointer Manipulation/PARENT_STRUCT

located at p_member.

SEE ALSO

-
       offsetof
+
       offsetof
 

-

[Definitions] +

[Definitions] Component Library: Unreferenced Parameters/UNUSED_PARAM

[top][index]

diff --git a/trunk/docs/complib/cl_vector_h.html b/trunk/docs/complib/cl_vector_h.html index 127f017f..14bd9ee0 100644 --- a/trunk/docs/complib/cl_vector_h.html +++ b/trunk/docs/complib/cl_vector_h.html @@ -2,19 +2,19 @@ -./inc_doc/complib/cl_vector_h.html +./inc_docs/complib/cl_vector_h.html -Generated from ./inc/complib/cl_vector.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_vector.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Vector

-

[top][index]

+

[top][parent][index]

NAME

       Vector
 
@@ -31,41 +31,41 @@ Component Library/Vector calls the initializer function on a per object basis when growing the array. The initializer is optional. - The initializer function can fail, and returns a cl_status_t. The vector + The initializer function can fail, and returns a cl_status_t. The vector will call the destructor function, if provided, for an element that failed initialization. If an initializer fails, a vector does not call the initializer for objects in the remainder of the new memory allocation. - The cl_vector_t structure should be treated as opaque and should be + The cl_vector_t structure should be treated as opaque and should be manipulated only through the provided functions.

SEE ALSO

       Structures:
-               cl_vector_t
+               cl_vector_t
 
        Callbacks:
-               cl_pfn_vec_init_t, cl_pfn_vec_dtor_t, cl_pfn_vec_apply_t,
-               cl_pfn_vec_find_t
+               cl_pfn_vec_init_t, cl_pfn_vec_dtor_t, cl_pfn_vec_apply_t,
+               cl_pfn_vec_find_t
 
        Item Manipulation:
                cl_vector_set_obj, cl_vector_obj
 
        Initialization:
-               cl_vector_construct, cl_vector_init, cl_vector_destroy
+               cl_vector_construct, cl_vector_init, cl_vector_destroy
 
        Manipulation:
-               cl_vector_get_capacity, cl_vector_set_capacity,
-               cl_vector_get_size, cl_vector_set_size, cl_vector_set_min_size
-               cl_vector_get_ptr, cl_vector_get, cl_vector_at, cl_vector_set
+               cl_vector_get_capacity, cl_vector_set_capacity,
+               cl_vector_get_size, cl_vector_set_size, cl_vector_set_min_size
+               cl_vector_get_ptr, cl_vector_get, cl_vector_at, cl_vector_set
 
        Search:
-               cl_vector_find_from_start, cl_vector_find_from_end
-               cl_vector_apply_func
+               cl_vector_find_from_start, cl_vector_find_from_end
+               cl_vector_apply_func
 

-

[Definitions] +

[Definitions] Component Library: Vector/cl_pfn_vec_apply_t

[top][index]

@@ -91,23 +91,23 @@ Component Library: Vector/cl_pfn_vec_apply_t

[in] Pointer to an element at the specified index in the vector. context - [in] Context provided in a call to cl_vector_apply_func. + [in] Context provided in a call to cl_vector_apply_func.

RETURN VALUE

       This function does not return a value.
 

NOTES

       This function type is provided as function prototype reference for
-       the function passed by users as a parameter to the cl_vector_apply_func
+       the function passed by users as a parameter to the cl_vector_apply_func
        function.
 

SEE ALSO

-
       Vector, cl_vector_apply_func
+
       Vector, cl_vector_apply_func
 

-

[Definitions] +

[Definitions] Component Library: Vector/cl_pfn_vec_dtor_t

[top][index]

@@ -129,7 +129,7 @@ Component Library: Vector/cl_pfn_vec_dtor_t

[in] Pointer to an element being deallocated from a vector. context - [in] Context provided in a call to cl_vector_init. + [in] Context provided in a call to cl_vector_init.

RETURN VALUE

       This function does not return a value.
@@ -137,15 +137,15 @@ Component Library: Vector/cl_pfn_vec_dtor_t
 

NOTES

       This function type is provided as function prototype reference for
        the destructor function provided by users as an optional parameter to
-       the cl_vector_init function.
+       the cl_vector_init function.
 

SEE ALSO

-
       Vector, cl_vector_init
+
       Vector, cl_vector_init
 

-

[Definitions] +

[Definitions] Component Library: Vector/cl_pfn_vec_find_t

[top][index]

@@ -157,7 +157,7 @@ Component Library: Vector/cl_pfn_vec_find_t

used to find elements in a vector.

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_vec_find_t)(
         IN      const size_t            index,
         IN      const void* const       p_element,
@@ -171,8 +171,8 @@ Component Library: Vector/cl_pfn_vec_find_t
                [in] Pointer to an element at the specified index in the vector.
 
        context
-               [in] Context provided in a call to cl_vector_find_from_start or
-               cl_vector_find_from_end.
+               [in] Context provided in a call to cl_vector_find_from_start or
+               cl_vector_find_from_end.
 
  RETURN VALUES
        Return CL_SUCCESS if the element was found. This stops vector iteration.
@@ -181,16 +181,16 @@ Component Library: Vector/cl_pfn_vec_find_t
 

NOTES

       This function type is provided as function prototype reference for the
-       function provided by users as a parameter to the cl_vector_find_from_start
-       and cl_vector_find_from_end functions.
+       function provided by users as a parameter to the cl_vector_find_from_start
+       and cl_vector_find_from_end functions.
 

SEE ALSO

-
       Vector, cl_vector_find_from_start, cl_vector_find_from_end
+
       Vector, cl_vector_find_from_start, cl_vector_find_from_end
 

-

[Definitions] +

[Definitions] Component Library: Vector/cl_pfn_vec_init_t

[top][index]

@@ -202,7 +202,7 @@ Component Library: Vector/cl_pfn_vec_init_t

used as initializer for elements being allocated by a vector.

SYNOPSIS

-
typedef cl_status_t
+
typedef cl_status_t
 (CL_API *cl_pfn_vec_init_t)(
         IN      void* const                     p_element,
         IN      void*                           context );
@@ -212,30 +212,30 @@ Component Library: Vector/cl_pfn_vec_init_t
                [in] Pointer to an element being added to a vector.
 
        context
-               [in] Context provided in a call to cl_vector_init.
+               [in] Context provided in a call to cl_vector_init.
 
  RETURN VALUES
        Return CL_SUCCESS to indicate that the element was initialized successfully.
 
-       Other cl_status_t values will be returned by the cl_vector_init,
-       cl_vector_set_size, and cl_vector_set_min_size functions.
+       Other cl_status_t values will be returned by the cl_vector_init,
+       cl_vector_set_size, and cl_vector_set_min_size functions.
 
        In situations where the vector's size needs to grows in order to satisfy
-       a call to cl_vector_set, a non-successful status returned by the
+       a call to cl_vector_set, a non-successful status returned by the
        initializer callback causes the growth to stop.
 

NOTES

       This function type is provided as function prototype reference for
        the initializer function provided by users as an optional parameter to
-       the cl_vector_init function.
+       the cl_vector_init function.
 

SEE ALSO

-
       Vector, cl_vector_init
+
       Vector, cl_vector_init
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_apply_func

[top][index]

@@ -249,17 +249,17 @@ Component Library: Vector/cl_vector_apply_func

SYNOPSIS

CL_EXPORT void CL_API
 cl_vector_apply_func(
-        IN      const cl_vector_t* const        p_vector,
-        IN      cl_pfn_vec_apply_t                      pfn_callback,
+        IN      const cl_vector_t* const        p_vector,
+        IN      cl_pfn_vec_apply_t                      pfn_callback,
         IN      const void* const                       context );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure whose elements to iterate.
+               [in] Pointer to a cl_vector_t structure whose elements to iterate.
 
        pfn_callback
                [in] Function invoked for every element in the array.
-               See the cl_pfn_vec_apply_t function type declaration for details
+               See the cl_pfn_vec_apply_t function type declaration for details
                about the callback function.
 
        context
@@ -273,13 +273,13 @@ Component Library: Vector/cl_vector_apply_func
        in the vector, starting from the beginning of the vector.
 

SEE ALSO

-
       Vector, cl_vector_find_from_start, cl_vector_find_from_end,
-       cl_pfn_vec_apply_t
+
       Vector, cl_vector_find_from_start, cl_vector_find_from_end,
+       cl_pfn_vec_apply_t
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_at

[top][index]

@@ -291,15 +291,15 @@ Component Library: Vector/cl_vector_at

specified index, performing boundary checks.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_vector_at(
-        IN      const cl_vector_t* const        p_vector,
+        IN      const cl_vector_t* const        p_vector,
         IN      const size_t                            index,
         OUT     void* const                                     p_element );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure from which to get a copy of
+               [in] Pointer to a cl_vector_t structure from which to get a copy of
                an element.
 
        index
@@ -321,12 +321,12 @@ Component Library: Vector/cl_vector_at
        Upon success, the p_element parameter contains a copy of the desired element.
 

SEE ALSO

-
       Vector, cl_vector_get, cl_vector_get_ptr
+
       Vector, cl_vector_get, cl_vector_get_ptr
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_construct

[top][index]

@@ -339,28 +339,28 @@ Component Library: Vector/cl_vector_construct

SYNOPSIS

CL_EXPORT void CL_API
 cl_vector_construct(
-        IN      cl_vector_t* const      p_vector );
+        IN      cl_vector_t* const      p_vector );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure to construct.
+               [in] Pointer to a cl_vector_t structure to construct.
 

RETURN VALUE

       This function does not return a value.
 

NOTES

-
       Allows calling cl_vector_destroy without first calling cl_vector_init.
+
       Allows calling cl_vector_destroy without first calling cl_vector_init.
 
        Calling cl_vector_construct is a prerequisite to calling any other
-       vector function except cl_vector_init.
+       vector function except cl_vector_init.
 

SEE ALSO

-
       Vector, cl_vector_init, cl_vector_destroy
+
       Vector, cl_vector_init, cl_vector_destroy
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_destroy

[top][index]

@@ -373,11 +373,11 @@ Component Library: Vector/cl_vector_destroy

SYNOPSIS

CL_EXPORT void CL_API
 cl_vector_destroy(
-        IN      cl_vector_t* const      p_vector );
+        IN      cl_vector_t* const      p_vector );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure to destroy.
+               [in] Pointer to a cl_vector_t structure to destroy.
 

RETURN VALUE

       This function does not return a value.
@@ -386,16 +386,16 @@ Component Library: Vector/cl_vector_destroy
 
       cl_vector_destroy frees all memory allocated for the vector. The vector
        is left initialized to a zero capacity and size.
 
-       This function should only be called after a call to cl_vector_construct
-       or cl_vector_init.
+       This function should only be called after a call to cl_vector_construct
+       or cl_vector_init.
 

SEE ALSO

-
       Vector, cl_vector_construct, cl_vector_init
+
       Vector, cl_vector_construct, cl_vector_init
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_find_from_end

[top][index]

@@ -409,17 +409,17 @@ Component Library: Vector/cl_vector_find_from_end

SYNOPSIS

CL_EXPORT size_t CL_API
 cl_vector_find_from_end(
-        IN      const cl_vector_t* const        p_vector,
-        IN      cl_pfn_vec_find_t                       pfn_callback,
+        IN      const cl_vector_t* const        p_vector,
+        IN      cl_pfn_vec_find_t                       pfn_callback,
         IN      const void* const                       context );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure to inititalize.
+               [in] Pointer to a cl_vector_t structure to inititalize.
 
        pfn_callback
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_vec_find_t function type declaration for details
+               See the cl_pfn_vec_find_t function type declaration for details
                about the callback function.
 
        context
@@ -436,13 +436,13 @@ Component Library: Vector/cl_vector_find_from_end
        provided by the pfn_callback parameter returns CL_SUCCESS.
 

SEE ALSO

-
       Vector, cl_vector_find_from_start, cl_vector_apply_func,
-       cl_pfn_vec_find_t
+
       Vector, cl_vector_find_from_start, cl_vector_apply_func,
+       cl_pfn_vec_find_t
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_find_from_start

[top][index]

@@ -456,17 +456,17 @@ Component Library: Vector/cl_vector_find_from_start

SYNOPSIS

CL_EXPORT size_t CL_API
 cl_vector_find_from_start(
-        IN      const cl_vector_t* const        p_vector,
-        IN      cl_pfn_vec_find_t                       pfn_callback,
+        IN      const cl_vector_t* const        p_vector,
+        IN      cl_pfn_vec_find_t                       pfn_callback,
         IN      const void* const                       context );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure to inititalize.
+               [in] Pointer to a cl_vector_t structure to inititalize.
 
        pfn_callback
                [in] Function invoked to determine if a match was found.
-               See the cl_pfn_vec_find_t function type declaration for details
+               See the cl_pfn_vec_find_t function type declaration for details
                about the callback function.
 
        context
@@ -483,12 +483,12 @@ Component Library: Vector/cl_vector_find_from_start
        provided by the pfn_callback parameter returns CL_SUCCESS.
 

SEE ALSO

-
       Vector, cl_vector_find_from_end, cl_vector_apply_func, cl_pfn_vec_find_t
+
       Vector, cl_vector_find_from_end, cl_vector_apply_func, cl_pfn_vec_find_t
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_get

[top][index]

@@ -502,7 +502,7 @@ Component Library: Vector/cl_vector_get

SYNOPSIS

CL_INLINE void CL_API
 cl_vector_get(
-        IN      const cl_vector_t* const        p_vector,
+        IN      const cl_vector_t* const        p_vector,
         IN      const size_t                            index,
         OUT     void* const                                     p_element )
 {
@@ -513,13 +513,13 @@ Component Library: Vector/cl_vector_get
         CL_ASSERT( p_element );
 
         /* Get a pointer to the element. */
-        p_src = cl_vector_get_ptr( p_vector, index );
+        p_src = cl_vector_get_ptr( p_vector, index );
         p_vector->pfn_copy( p_element, p_src, p_vector->element_size );
 }
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure from which to get a copy of
+               [in] Pointer to a cl_vector_t structure from which to get a copy of
                an element.
 
        index
@@ -538,18 +538,18 @@ Component Library: Vector/cl_vector_get
        cl_vector_get does not perform boundary checking on the vector, and
        callers are responsible for providing an index that is within the range
        of the vector. To access elements after performing boundary checks,
-       use cl_vector_at.
+       use cl_vector_at.
 
        The p_element parameter contains a copy of the desired element upon
        return from this function.
 

SEE ALSO

-
       Vector, cl_vector_get_ptr, cl_vector_at
+
       Vector, cl_vector_get_ptr, cl_vector_at
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_get_capacity

[top][index]

@@ -562,7 +562,7 @@ Component Library: Vector/cl_vector_get_capacity

SYNOPSIS

CL_INLINE size_t CL_API
 cl_vector_get_capacity(
-        IN      const cl_vector_t* const        p_vector )
+        IN      const cl_vector_t* const        p_vector )
 {
         CL_ASSERT( p_vector );
         CL_ASSERT( p_vector->state == CL_INITIALIZED );
@@ -572,7 +572,7 @@ Component Library: Vector/cl_vector_get_capacity
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure whose capacity to return.
+               [in] Pointer to a cl_vector_t structure whose capacity to return.
 

RETURN VALUE

       Capacity, in elements, of the vector.
@@ -580,15 +580,15 @@ Component Library: Vector/cl_vector_get_capacity
 

NOTES

       The capacity is the number of elements that the vector can store, and
        can be greater than the number of elements stored. To get the number of
-       elements stored in the vector, use cl_vector_get_size.
+       elements stored in the vector, use cl_vector_get_size.
 

SEE ALSO

-
       Vector, cl_vector_set_capacity, cl_vector_get_size
+
       Vector, cl_vector_set_capacity, cl_vector_get_size
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_get_ptr

[top][index]

@@ -602,7 +602,7 @@ Component Library: Vector/cl_vector_get_ptr

SYNOPSIS

CL_INLINE void* CL_API
 cl_vector_get_ptr(
-        IN      const cl_vector_t* const        p_vector,
+        IN      const cl_vector_t* const        p_vector,
         IN      const size_t                            index )
 {
         CL_ASSERT( p_vector );
@@ -613,7 +613,7 @@ Component Library: Vector/cl_vector_get_ptr
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure from which to get a
+               [in] Pointer to a cl_vector_t structure from which to get a
                pointer to an element.
 
        index
@@ -629,12 +629,12 @@ Component Library: Vector/cl_vector_get_ptr
        responsible for providing an index that is within the range of the vector.
 

SEE ALSO

-
       Vector, cl_vector_get, cl_vector_at, cl_vector_set, cl_vector_get_size
+
       Vector, cl_vector_get, cl_vector_at, cl_vector_set, cl_vector_get_size
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_get_size

[top][index]

@@ -647,7 +647,7 @@ Component Library: Vector/cl_vector_get_size

SYNOPSIS

CL_INLINE size_t CL_API
 cl_vector_get_size(
-        IN      const cl_vector_t* const        p_vector )
+        IN      const cl_vector_t* const        p_vector )
 {
         CL_ASSERT( p_vector );
         CL_ASSERT( p_vector->state == CL_INITIALIZED );
@@ -657,18 +657,18 @@ Component Library: Vector/cl_vector_get_size
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure whose size to return.
+               [in] Pointer to a cl_vector_t structure whose size to return.
 

RETURN VALUE

       Size, in elements, of the vector.
 

SEE ALSO

-
       Vector, cl_vector_set_size, cl_vector_get_capacity
+
       Vector, cl_vector_set_size, cl_vector_get_capacity
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_init

[top][index]

@@ -679,19 +679,19 @@ Component Library: Vector/cl_vector_init

       The cl_vector_init function initializes a vector for use.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_vector_init(
-        IN      cl_vector_t* const      p_vector,
+        IN      cl_vector_t* const      p_vector,
         IN      const size_t            min_size,
         IN      const size_t            grow_size,
         IN      const size_t            element_size,
-        IN      cl_pfn_vec_init_t       pfn_init OPTIONAL,
-        IN      cl_pfn_vec_dtor_t       pfn_dtor OPTIONAL,
+        IN      cl_pfn_vec_init_t       pfn_init OPTIONAL,
+        IN      cl_pfn_vec_dtor_t       pfn_dtor OPTIONAL,
         IN      const void* const       context );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure to inititalize.
+               [in] Pointer to a cl_vector_t structure to inititalize.
 
        initial_size
                [in] Initial number of elements.
@@ -705,12 +705,12 @@ Component Library: Vector/cl_vector_init
 
        pfn_init
                [in] Initializer callback to invoke for every new element.
-               See the cl_pfn_vec_init_t function type declaration for details about
+               See the cl_pfn_vec_init_t function type declaration for details about
                the callback function.
 
        pfn_dtor
                [in] Destructor callback to invoke for elements being deallocated.
-               See the cl_pfn_vec_dtor_t function type declaration for details about
+               See the cl_pfn_vec_dtor_t function type declaration for details about
                the callback function.
 
        context
@@ -721,7 +721,7 @@ Component Library: Vector/cl_vector_init
 
        CL_INSUFFICIENT_MEMORY if the initialization failed.
 
-       cl_status_t value returned by optional initializer function specified by
+       cl_status_t value returned by optional initializer function specified by
        the pfn_init parameter.
 

NOTES

@@ -729,13 +729,13 @@ Component Library: Vector/cl_vector_init new element in the array.

SEE ALSO

-
       Vector, cl_vector_construct, cl_vector_destroy, cl_vector_set,
-       cl_vector_get, cl_vector_get_ptr, cl_vector_at
+
       Vector, cl_vector_construct, cl_vector_destroy, cl_vector_set,
+       cl_vector_get, cl_vector_get_ptr, cl_vector_at
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_set

[top][index]

@@ -746,15 +746,15 @@ Component Library: Vector/cl_vector_set

       The cl_vector_set function sets the element at the specified index.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_vector_set(
-        IN      cl_vector_t* const      p_vector,
+        IN      cl_vector_t* const      p_vector,
         IN      const size_t            index,
         IN      void* const                     p_element );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure into which to store
+               [in] Pointer to a cl_vector_t structure into which to store
                an element.
 
        index
@@ -771,16 +771,16 @@ Component Library: Vector/cl_vector_set
 

NOTES

       cl_vector_set grows the vector as needed to accommodate the new element,
-       unless the grow_size parameter passed into the cl_vector_init function
+       unless the grow_size parameter passed into the cl_vector_init function
        was zero.
 

SEE ALSO

-
       Vector, cl_vector_get
+
       Vector, cl_vector_get
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_set_capacity

[top][index]

@@ -792,14 +792,14 @@ Component Library: Vector/cl_vector_set_capacity

specified number of elements.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_vector_set_capacity(
-        IN      cl_vector_t* const      p_vector,
+        IN      cl_vector_t* const      p_vector,
         IN      const size_t            new_capacity );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure whose capacity to set.
+               [in] Pointer to a cl_vector_t structure whose capacity to set.
 
        new_capacity
                [in] Total number of elements for which the vector should
@@ -817,13 +817,13 @@ Component Library: Vector/cl_vector_set_capacity
        than the current capacity, the vector is left unchanged.
 

SEE ALSO

-
       Vector, cl_vector_get_capacity, cl_vector_set_size,
-       cl_vector_set_min_size
+
       Vector, cl_vector_get_capacity, cl_vector_set_size,
+       cl_vector_set_min_size
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_set_min_size

[top][index]

@@ -835,14 +835,14 @@ Component Library: Vector/cl_vector_set_min_size

if the vector is smaller than the specified size.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_vector_set_min_size(
-        IN      cl_vector_t* const      p_vector,
+        IN      cl_vector_t* const      p_vector,
         IN      const size_t            min_size );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure whose minimum size to set.
+               [in] Pointer to a cl_vector_t structure whose minimum size to set.
 
        min_size
                [in] Minimum number of elements that the vector should contain.
@@ -861,12 +861,12 @@ Component Library: Vector/cl_vector_set_min_size
        to insufficient memory being available to perform the operation.
 

SEE ALSO

-
       Vector, cl_vector_get_size, cl_vector_set_size, cl_vector_set_capacity
+
       Vector, cl_vector_get_size, cl_vector_set_size, cl_vector_set_capacity
 

-

[Functions] +

[Functions] Component Library: Vector/cl_vector_set_size

[top][index]

@@ -878,14 +878,14 @@ Component Library: Vector/cl_vector_set_size

decreasing its size.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_vector_set_size(
-        IN      cl_vector_t* const      p_vector,
+        IN      cl_vector_t* const      p_vector,
         IN      const size_t            size );
 

PARAMETERS

       p_vector
-               [in] Pointer to a cl_vector_t structure whose size to set.
+               [in] Pointer to a cl_vector_t structure whose size to set.
 
        size
                [in] Number of elements desired in the vector.
@@ -906,13 +906,13 @@ Component Library: Vector/cl_vector_set_size
        This function can only fail if size is larger than the current capacity.
 

SEE ALSO

-
       Vector, cl_vector_get_size, cl_vector_set_min_size,
-       cl_vector_set_capacity
+
       Vector, cl_vector_get_size, cl_vector_set_min_size,
+       cl_vector_set_capacity
 

-

[Structures] +

[Structures] Component Library: Vector/cl_vector_t

[top][index]

@@ -932,11 +932,11 @@ Component Library: Vector/cl_vector_t

size_t grow_size; size_t capacity; size_t element_size; - cl_pfn_vec_init_t pfn_init; - cl_pfn_vec_dtor_t pfn_dtor; + cl_pfn_vec_init_t pfn_init; + cl_pfn_vec_dtor_t pfn_dtor; cl_pfn_vec_copy_t pfn_copy; const void *context; - cl_qlist_t alloc_list; + cl_qlist_t alloc_list; void **p_ptr_array; cl_state_t state; @@ -968,7 +968,7 @@ Component Library: Vector/cl_vector_t User context for callbacks. alloc_list - List of allocations. + List of allocations. p_ptr_array Internal array of pointers to elements. diff --git a/trunk/docs/complib/cl_waitobj_h.html b/trunk/docs/complib/cl_waitobj_h.html index da2d75fe..63bf9724 100644 --- a/trunk/docs/complib/cl_waitobj_h.html +++ b/trunk/docs/complib/cl_waitobj_h.html @@ -2,48 +2,48 @@ -./inc_doc/complib/cl_waitobj_h.html +./inc_docs/complib/cl_waitobj_h.html -Generated from ./inc/complib/cl_waitobj.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/cl_waitobj.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Wait Object

-

[top][index]

+

[top][parent][index]

NAME

-
       Wait Object
+
       Wait Object
 

DESCRIPTION

-
       The Wait Object provides the capability for a user mode process to
+
       The Wait Object provides the capability for a user mode process to
        create and manipulate a wait object that can also be manipulated from
        kernel mode.
 

SEE ALSO

       Structures:
-               cl_waitobj_handle_t
+               cl_waitobj_handle_t
 
        User Mode Initialization/Destruction:
-               cl_waitobj_create
-               cl_waitobj_destroy
+               cl_waitobj_create
+               cl_waitobj_destroy
 
        Kernel Mode Access:
-               cl_waitobj_ref
-               cl_waitobj_deref
+               cl_waitobj_ref
+               cl_waitobj_deref
 
        Manipulation:
-               cl_waitobj_signal
-               cl_waitobj_reset
-               cl_waitobj_wait_on
+               cl_waitobj_signal
+               cl_waitobj_reset
+               cl_waitobj_wait_on
 

-

[Functions] +

[Functions] Component Library: Wait Object/cl_waitobj_create

[top][index]

@@ -54,16 +54,16 @@ Component Library: Wait Object/cl_waitobj_create

       The cl_waitobj_create function creates a wait object.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_waitobj_create(
         IN      const boolean_t                         manual_reset, 
-        OUT     cl_waitobj_handle_t* const      ph_wait_obj );
+        OUT     cl_waitobj_handle_t* const      ph_wait_obj );
 

PARAMETERS

       manual_reset
                [in] If FALSE, indicates that the event resets itself after releasing 
                a single waiter.  If TRUE, the event remains in the signalled state 
-               until explicitly reset by a call to cl_event_reset.
+               until explicitly reset by a call to cl_event_reset.
 
        ph_wait_obj
                [out] Pointer to a wait object handle set upon successful creation.
@@ -77,13 +77,13 @@ Component Library: Wait Object/cl_waitobj_create
 
       This function is only available in user mode.
 

SEE ALSO

-
       Wait Object, cl_waitobj_handle_t, cl_waitobj_destroy, 
-       cl_waitobj_signal, cl_waitobj_reset, cl_waitobj_wait_on
+
       Wait Object, cl_waitobj_handle_t, cl_waitobj_destroy, 
+       cl_waitobj_signal, cl_waitobj_reset, cl_waitobj_wait_on
 

-

[Functions] +

[Functions] Component Library: Wait Object/cl_waitobj_deref

[top][index]

@@ -98,11 +98,11 @@ Component Library: Wait Object/cl_waitobj_deref

SYNOPSIS

CL_EXPORT void CL_API
 cl_waitobj_deref(
-        IN      cl_waitobj_handle_t     h_kernel_wait_obj );
+        IN      cl_waitobj_handle_t     h_kernel_wait_obj );
 

PARAMETERS

       h_kernel_wait_obj
-               [in] A wait object handle returned by a previous call to cl_waitobj_ref. 
+               [in] A wait object handle returned by a previous call to cl_waitobj_ref. 
 
  RETURN VALUES
        This function does not return a value.
@@ -111,13 +111,13 @@ Component Library: Wait Object/cl_waitobj_deref
 
       This function is only available in kernel mode.
 

SEE ALSO

-
       Wait Object, cl_waitobj_handle_t, cl_waitobj_ref, 
-       cl_waitobj_signal, cl_waitobj_reset, cl_waitobj_wait_on
+
       Wait Object, cl_waitobj_handle_t, cl_waitobj_ref, 
+       cl_waitobj_signal, cl_waitobj_reset, cl_waitobj_wait_on
 

-

[Functions] +

[Functions] Component Library: Wait Object/cl_waitobj_destroy

[top][index]

@@ -128,14 +128,14 @@ Component Library: Wait Object/cl_waitobj_destroy

       The cl_waitobj_destroy function destroys a wait object.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_waitobj_destroy(
-        IN      cl_waitobj_handle_t     h_wait_obj );
+        IN      cl_waitobj_handle_t     h_wait_obj );
 

PARAMETERS

       h_wait_obj
                [in] A handle to the wait object to destroy, obtained by a pervious
-               call to cl_waitobj_create.
+               call to cl_waitobj_create.
 
  RETURN VALUES
        CL_SUCCESS if the wait object handle is destroyed.
@@ -146,13 +146,13 @@ Component Library: Wait Object/cl_waitobj_destroy
 
       This function is only available in user mode.
 

SEE ALSO

-
       Wait Object, cl_waitobj_handle_t, cl_waitobj_create, 
-       cl_waitobj_signal, cl_waitobj_reset, cl_waitobj_wait_on
+
       Wait Object, cl_waitobj_handle_t, cl_waitobj_create, 
+       cl_waitobj_signal, cl_waitobj_reset, cl_waitobj_wait_on
 

-

[Definitions] +

[Definitions] Component Library: Wait Object/cl_waitobj_handle_t

[top][index]

@@ -167,14 +167,14 @@ Component Library: Wait Object/cl_waitobj_handle_t

differently depending on the target environment.

SEE ALSO

-
       Wait Object, cl_waitobj_create, cl_waitobj_destroy,
-       cl_waitobj_ref, cl_waitobj_deref, cl_waitobj_signal,
-       cl_waitobj_reset, cl_waitobj_wait_on
+
       Wait Object, cl_waitobj_create, cl_waitobj_destroy,
+       cl_waitobj_ref, cl_waitobj_deref, cl_waitobj_signal,
+       cl_waitobj_reset, cl_waitobj_wait_on
 

-

[Functions] +

[Functions] Component Library: Wait Object/cl_waitobj_ref

[top][index]

@@ -189,7 +189,7 @@ Component Library: Wait Object/cl_waitobj_ref

SYNOPSIS

-
CL_EXPORT cl_waitobj_handle_t CL_API
+
CL_EXPORT cl_waitobj_handle_t CL_API
 cl_waitobj_ref(
         IN      void                                    *h_user_wait_obj );
 
@@ -207,13 +207,13 @@ Component Library: Wait Object/cl_waitobj_ref
       This function is only available in kernel mode.
 

SEE ALSO

-
       Wait Object, cl_waitobj_handle_t, cl_waitobj_deref,
-       cl_waitobj_signal, cl_waitobj_reset, cl_waitobj_wait_on
+
       Wait Object, cl_waitobj_handle_t, cl_waitobj_deref,
+       cl_waitobj_signal, cl_waitobj_reset, cl_waitobj_wait_on
 

-

[Functions] +

[Functions] Component Library: Wait Object/cl_waitobj_reset

[top][index]

@@ -224,9 +224,9 @@ Component Library: Wait Object/cl_waitobj_reset

       The cl_waitobj_reset function sets an wait object to the non-signalled state.
 

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_waitobj_reset(
-        IN      cl_waitobj_handle_t     h_wait_obj );
+        IN      cl_waitobj_handle_t     h_wait_obj );
 

PARAMETERS

       h_wait_obj
@@ -242,14 +242,14 @@ Component Library: Wait Object/cl_waitobj_reset
        a wait object handle.
 

SEE ALSO

-
       Wait Object, cl_waitobj_create, cl_waitobj_destroy,
-       cl_waitobj_ref, cl_waitobj_deref,
-       cl_waitobj_signal, cl_waitobj_wait_on
+
       Wait Object, cl_waitobj_create, cl_waitobj_destroy,
+       cl_waitobj_ref, cl_waitobj_deref,
+       cl_waitobj_signal, cl_waitobj_wait_on
 

-

[Functions] +

[Functions] Component Library: Wait Object/cl_waitobj_signal

[top][index]

@@ -261,9 +261,9 @@ Component Library: Wait Object/cl_waitobj_signal

state and releases one or more waiting threads.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_waitobj_signal(
-        IN      cl_waitobj_handle_t     h_wait_obj );
+        IN      cl_waitobj_handle_t     h_wait_obj );
 

PARAMETERS

       h_wait_obj
@@ -287,14 +287,14 @@ Component Library: Wait Object/cl_waitobj_signal
        a wait object handle.
 

SEE ALSO

-
       Wait Object, cl_waitobj_create, cl_waitobj_destroy,
-       cl_waitobj_ref, cl_waitobj_deref,
-       cl_waitobj_reset, cl_waitobj_wait_on
+
       Wait Object, cl_waitobj_create, cl_waitobj_destroy,
+       cl_waitobj_ref, cl_waitobj_deref,
+       cl_waitobj_reset, cl_waitobj_wait_on
 

-

[Functions] +

[Functions] Component Library: Wait Object/cl_waitobj_wait_on

[top][index]

@@ -306,9 +306,9 @@ Component Library: Wait Object/cl_waitobj_wait_on

triggered for a minimum amount of time.

SYNOPSIS

-
CL_EXPORT cl_status_t CL_API
+
CL_EXPORT cl_status_t CL_API
 cl_waitobj_wait_on(
-        IN      cl_waitobj_handle_t             h_wait_obj,
+        IN      cl_waitobj_handle_t             h_wait_obj,
         IN      const uint32_t                  wait_us,
         IN      const boolean_t                 interruptible );
 
@@ -347,9 +347,9 @@ Component Library: Wait Object/cl_waitobj_wait_on a wait object handle.

SEE ALSO

-
       Wait Object, cl_waitobj_create, cl_waitobj_destroy,
-       cl_waitobj_ref, cl_waitobj_deref, 
-       cl_waitobj_signal, cl_waitobj_reset
+
       Wait Object, cl_waitobj_create, cl_waitobj_destroy,
+       cl_waitobj_ref, cl_waitobj_deref, 
+       cl_waitobj_signal, cl_waitobj_reset
 
diff --git a/trunk/docs/complib/comp_lib_h.html b/trunk/docs/complib/comp_lib_h.html index ccfced7b..1b2a13af 100644 --- a/trunk/docs/complib/comp_lib_h.html +++ b/trunk/docs/complib/comp_lib_h.html @@ -2,21 +2,21 @@ -./inc_doc/complib/comp_lib_h.html +./inc_docs/complib/comp_lib_h.html -Generated from ./inc/complib/comp_lib.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/complib/comp_lib.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] -Component Library/Overview

+

[Modules] +Component Library/Component Library

[top][index]

NAME

-
       Overview
+
       component library 
 

DESCRIPTION

       The component library is a collection of components that can be used to
diff --git a/trunk/docs/iba/ib_al_h.html b/trunk/docs/iba/ib_al_h.html
index 31baae27..606d8b21 100644
--- a/trunk/docs/iba/ib_al_h.html
+++ b/trunk/docs/iba/ib_al_h.html
@@ -2,17 +2,17 @@
 
 
 
-./inc_doc/iba/ib_al_h.html
+./inc_docs/iba/ib_al_h.html
 
 
 
 
-Generated from ./inc/iba/ib_al.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31
+Generated from ./inc/iba/ib_al.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38
 

-

[Modules] -IB Access Layer API/Overview

+

[Modules] +IB Access Layer API/Access Layer

[top][index]

NAME

@@ -36,7 +36,7 @@ IB Access Layer API/Overview

[Definitions] Access Layer/ATS

-

[top][index]

+

[top][parent][index]

NAME

       DAPL Address Translation Service
 
@@ -50,7 +50,7 @@ Access Layer/ATS

[Functions] Access Layer/ib_add_svc_entry

-

[top][index]

+

[top][parent][index]

NAME

       ib_add_svc_entry
 
@@ -61,7 +61,7 @@ Access Layer/ib_add_svc_entry
AL_EXPORT ib_api_status_t AL_API
 ib_add_svc_entry(
         IN              const   ib_ioc_handle_t                         h_ioc,
-        IN              const   ib_svc_entry_t* const           p_svc_entry,
+        IN              const   ib_svc_entry_t* const           p_svc_entry,
                 OUT                     ib_svc_handle_t* const          ph_svc );
 

PARAMETERS

@@ -102,7 +102,7 @@ Access Layer/ib_add_svc_entry controller is registered with the local device manager.

SEE ALSO

-
       ib_create_ioc, ib_remove_svc_entry, ib_reg_ioc, ib_svc_entry_t
+
       ib_create_ioc, ib_remove_svc_entry, ib_reg_ioc, ib_svc_entry_t
 

@@ -110,7 +110,7 @@ Access Layer/ib_add_svc_entry

[Definitions] Access Layer/ib_al_flags_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_al_flags_t
 
@@ -137,7 +137,7 @@ Access Layer/ib_al_flags_t

[Functions] Access Layer/ib_alloc_pd

-

[top][index]

+

[top][parent][index]

NAME

       ib_alloc_pd
 
@@ -199,7 +199,7 @@ Access Layer/ib_alloc_pd

[Structures] Access Layer/ib_apr_info_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_apr_info_t
 
@@ -222,7 +222,7 @@ Access Layer/ib_apr_info_t

[Structures] Access Layer/ib_apr_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_apr_pdata_t
 
@@ -245,7 +245,7 @@ Access Layer/ib_apr_pdata_t

[Structures] Access Layer/ib_ari_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_ari_t
 
@@ -268,7 +268,7 @@ Access Layer/ib_ari_t

[Structures] Access Layer/ib_async_event_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_async_event_rec_t
 
@@ -279,7 +279,7 @@ Access Layer/ib_async_event_rec_t

SYNOPSIS

typedef struct _ib_async_event_rec
 {
-        ib_async_event_t                                                        code;
+        ib_async_event_t                                                        code;
         uint64_t                                                                        vendor_specific;
 
         void* __ptr64                                                           context;
@@ -311,7 +311,7 @@ Access Layer/ib_async_event_rec_t
                call to create a resource can return.
 

SEE ALSO

-
       ib_async_event_t, ib_pfn_event_cb_t
+
       ib_async_event_t, ib_pfn_event_cb_t
 

@@ -319,7 +319,7 @@ Access Layer/ib_async_event_rec_t

[Functions] Access Layer/ib_bind_mw

-

[top][index]

+

[top][parent][index]

NAME

       ib_bind_mw
 
@@ -397,7 +397,7 @@ Access Layer/ib_bind_mw

[Functions] Access Layer/ib_cancel_mad

-

[top][index]

+

[top][parent][index]

NAME

       ib_cancel_mad
 
@@ -444,7 +444,7 @@ Access Layer/ib_cancel_mad

[Functions] Access Layer/ib_cancel_query

-

[top][index]

+

[top][parent][index]

NAME

       ib_cancel_query
 
@@ -482,7 +482,7 @@ Access Layer/ib_cancel_query

[Structures] Access Layer/ib_cep_listen_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cep_listen_t
 
@@ -541,7 +541,7 @@ Access Layer/ib_cep_listen_t

[Functions] Access Layer/ib_ci_call

-

[top][index]

+

[top][parent][index]

NAME

       ib_ci_call
 
@@ -621,7 +621,7 @@ Access Layer/ib_ci_call

[Functions] Access Layer/ib_close_al

-

[top][index]

+

[top][parent][index]

NAME

       ib_close_al
 
@@ -662,7 +662,7 @@ Access Layer/ib_close_al

[Functions] Access Layer/ib_close_ca

-

[top][index]

+

[top][parent][index]

NAME

       ib_close_ca
 
@@ -709,7 +709,7 @@ Access Layer/ib_close_ca

[Functions] Access Layer/ib_cm_apr

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_apr
 
@@ -769,7 +769,7 @@ Access Layer/ib_cm_apr

[Structures] Access Layer/ib_cm_apr_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_apr_rec_t
 
@@ -834,7 +834,7 @@ Access Layer/ib_cm_apr_rec_t

[Structures] Access Layer/ib_cm_apr_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_apr_t
 
@@ -893,7 +893,7 @@ Access Layer/ib_cm_apr_t

[Functions] Access Layer/ib_cm_cancel

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_cancel
 
@@ -936,7 +936,7 @@ Access Layer/ib_cm_cancel

[Functions] Access Layer/ib_cm_drep

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_drep
 
@@ -993,7 +993,7 @@ Access Layer/ib_cm_drep

[Structures] Access Layer/ib_cm_drep_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_drep_rec_t
 
@@ -1038,7 +1038,7 @@ Access Layer/ib_cm_drep_rec_t

[Structures] Access Layer/ib_cm_drep_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_drep_t
 
@@ -1070,7 +1070,7 @@ Access Layer/ib_cm_drep_t

[Functions] Access Layer/ib_cm_dreq

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_dreq
 
@@ -1122,7 +1122,7 @@ Access Layer/ib_cm_dreq

[Structures] Access Layer/ib_cm_dreq_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_dreq_rec_t
 
@@ -1162,7 +1162,7 @@ Access Layer/ib_cm_dreq_rec_t

[Structures] Access Layer/ib_cm_dreq_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_dreq_t
 
@@ -1222,7 +1222,7 @@ Access Layer/ib_cm_dreq_t

[Definitions] Access Layer/ib_cm_failover_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_failover_t
 
@@ -1247,7 +1247,7 @@ Access Layer/ib_cm_failover_t

[Functions] Access Layer/ib_cm_handoff

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_handoff
 
@@ -1258,7 +1258,7 @@ Access Layer/ib_cm_handoff
AL_EXPORT ib_api_status_t AL_API
 ib_cm_handoff(
         IN              const   ib_cm_handle_t                          h_cm_req,
-        IN              const   ib_net64_t                                      svc_id );
+        IN              const   ib_net64_t                                      svc_id );
 

PARAMETERS

       h_cm_req
@@ -1298,7 +1298,7 @@ Access Layer/ib_cm_handoff
 

[Functions] Access Layer/ib_cm_lap

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_lap
 
@@ -1366,7 +1366,7 @@ Access Layer/ib_cm_lap

[Structures] Access Layer/ib_cm_lap_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_lap_rec_t
 
@@ -1378,7 +1378,7 @@ Access Layer/ib_cm_lap_rec_t
typedef struct _ib_cm_lap_rec
 {
         ib_cm_handle_t                          h_cm_lap;
-        ib_path_rec_t                           alt_path;
+        ib_path_rec_t                           alt_path;
 
         const uint8_t* __ptr64          p_lap_pdata;
 
@@ -1411,7 +1411,7 @@ Access Layer/ib_cm_lap_rec_t
 

[Structures] Access Layer/ib_cm_lap_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_lap_t
 
@@ -1433,7 +1433,7 @@ Access Layer/ib_cm_lap_t ib_qp_handle_t h_qp; uint8_t remote_resp_timeout; - ib_path_rec_t* __ptr64 p_alt_path; + ib_path_rec_t* __ptr64 p_alt_path; ib_pfn_cm_apr_cb_t pfn_cm_apr_cb; } ib_cm_lap_t; @@ -1469,7 +1469,7 @@ Access Layer/ib_cm_lap_t response to the load request is received.

SEE ALSO

-
       ib_cm_lap, ib_pfn_cm_lap_cb_t, ib_pfn_cm_apr_cb_t, ib_path_rec_t,
+
       ib_cm_lap, ib_pfn_cm_lap_cb_t, ib_pfn_cm_apr_cb_t, ib_path_rec_t,
        ib_pfn_lap_pdata_t, ib_qp_type_t
 
@@ -1478,7 +1478,7 @@ Access Layer/ib_cm_lap_t

[Functions] Access Layer/ib_cm_listen

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_listen
 
@@ -1571,7 +1571,7 @@ Access Layer/ib_cm_listen

[Structures] Access Layer/ib_cm_listen_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_listen_t
 
@@ -1581,12 +1581,12 @@ Access Layer/ib_cm_listen_t

SYNOPSIS

typedef struct _ib_cm_listen
 {
-        ib_net64_t                                      svc_id;
+        ib_net64_t                                      svc_id;
 
-        ib_net64_t                                      ca_guid;
-        ib_net64_t                                      port_guid;
-        ib_net16_t                                      lid;
-        ib_net16_t                                      pkey;
+        ib_net64_t                                      ca_guid;
+        ib_net64_t                                      port_guid;
+        ib_net16_t                                      lid;
+        ib_net16_t                                      pkey;
 
         uint8_t* __ptr64                        p_compare_buffer;
         uint8_t                                         compare_offset;
@@ -1681,7 +1681,7 @@ Access Layer/ib_cm_listen_t
 

[Functions] Access Layer/ib_cm_mra

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_mra
 
@@ -1744,7 +1744,7 @@ Access Layer/ib_cm_mra

[Structures] Access Layer/ib_cm_mra_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_mra_rec_t
 
@@ -1781,7 +1781,7 @@ Access Layer/ib_cm_mra_rec_t

[Structures] Access Layer/ib_cm_mra_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_mra_t
 
@@ -1822,7 +1822,7 @@ Access Layer/ib_cm_mra_t

[Functions] Access Layer/ib_cm_rej

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_rej
 
@@ -1868,7 +1868,7 @@ Access Layer/ib_cm_rej

[Structures] Access Layer/ib_cm_rej_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_rej_rec_t
 
@@ -1922,7 +1922,7 @@ Access Layer/ib_cm_rej_rec_t

[Structures] Access Layer/ib_cm_rej_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_rej_t
 
@@ -1969,7 +1969,7 @@ Access Layer/ib_cm_rej_t

[Functions] Access Layer/ib_cm_rep

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_rep
 
@@ -2044,7 +2044,7 @@ Access Layer/ib_cm_rep

[Structures] Access Layer/ib_cm_rep_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_rep_rec_t
 
@@ -2069,9 +2069,9 @@ Access Layer/ib_cm_rep_rec_t /* valid for ud qp_type only */ const void* __ptr64 sidr_context; ib_sidr_status_t status; - ib_net32_t remote_qp; - ib_net32_t remote_qkey; - ib_class_port_info_t class_info; + ib_net32_t remote_qp; + ib_net32_t remote_qkey; + ib_class_port_info_t class_info; } ib_cm_rep_rec_t;
@@ -2135,7 +2135,7 @@ Access Layer/ib_cm_rep_rec_t

[Structures] Access Layer/ib_cm_rep_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_rep_t
 
@@ -2176,7 +2176,7 @@ Access Layer/ib_cm_rep_t /*valid for ud qp_type only */ ib_sidr_status_t status; - ib_class_port_info_t class_info; + ib_class_port_info_t class_info; } ib_cm_rep_t;
@@ -2274,7 +2274,7 @@ Access Layer/ib_cm_rep_t

[Functions] Access Layer/ib_cm_req

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_req
 
@@ -2342,7 +2342,7 @@ Access Layer/ib_cm_req

[Structures] Access Layer/ib_cm_req_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_req_rec_t
 
@@ -2366,11 +2366,11 @@ typedef struct _ib_cm_req_rec uint8_t resp_res; boolean_t flow_ctrl; uint8_t rnr_retry_cnt; - ib_path_rec_t primary_path; - ib_path_rec_t alt_path; + ib_path_rec_t primary_path; + ib_path_rec_t alt_path; /* valid for ud qp_type only */ - ib_net16_t pkey; + ib_net16_t pkey; const void* __ptr64 sidr_context; } ib_cm_req_rec_t; @@ -2427,7 +2427,7 @@ typedef struct _ib_cm_req_rec

SEE ALSO

       ib_cm_req, ib_cm_listen, ib_pfn_cm_req_cb_t,
-       ib_access_t, ib_path_rec_t, ib_req_pdata_t, ib_qp_type_t
+       ib_access_t, ib_path_rec_t, ib_req_pdata_t, ib_qp_type_t
 

@@ -2435,7 +2435,7 @@ typedef struct _ib_cm_req_rec

[Structures] Access Layer/ib_cm_req_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_req_t
 
@@ -2445,12 +2445,12 @@ Access Layer/ib_cm_req_t

SYNOPSIS

typedef struct _ib_cm_req
 {
-        ib_net64_t                                      svc_id;
+        ib_net64_t                                      svc_id;
 
         ib_al_flags_t                           flags;
         uint8_t                                         max_cm_retries;
 
-        ib_path_rec_t* __ptr64          p_primary_path;
+        ib_path_rec_t* __ptr64          p_primary_path;
 
         ib_pfn_cm_rep_cb_t                      pfn_cm_rep_cb;
 
@@ -2475,7 +2475,7 @@ Access Layer/ib_cm_req_t
         uint8_t                                         rnr_retry_cnt;
         uint8_t                                         retry_cnt;
 
-        ib_path_rec_t* __ptr64          p_alt_path OPTIONAL;
+        ib_path_rec_t* __ptr64          p_alt_path OPTIONAL;
 
         ib_pfn_cm_req_cb_t                      pfn_cm_req_cb;
         ib_pfn_cm_mra_cb_t                      pfn_cm_mra_cb;
@@ -2485,7 +2485,7 @@ Access Layer/ib_cm_req_t
         ib_al_handle_t                          h_al;
         const void* __ptr64                     sidr_context;
         uint32_t                                        timeout_ms;
-        ib_net16_t                                      pkey;
+        ib_net16_t                                      pkey;
 
 }       ib_cm_req_t;
 
@@ -2607,7 +2607,7 @@ Access Layer/ib_cm_req_t

SEE ALSO

       ib_cm_req, ib_pfn_cm_req_cb_t, ib_pfn_cm_rep_cb_t, ib_pfn_cm_mra_cb_t,
-       ib_pfn_cm_rej_cb_t, ib_path_rec_t, ib_req_pdata_t, ib_qp_type_t
+       ib_pfn_cm_rej_cb_t, ib_path_rec_t, ib_req_pdata_t, ib_qp_type_t
 

@@ -2615,7 +2615,7 @@ Access Layer/ib_cm_req_t

[Functions] Access Layer/ib_cm_rtu

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_rtu
 
@@ -2676,7 +2676,7 @@ Access Layer/ib_cm_rtu

[Structures] Access Layer/ib_cm_rtu_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_rtu_rec_t
 
@@ -2715,7 +2715,7 @@ Access Layer/ib_cm_rtu_rec_t

[Structures] Access Layer/ib_cm_rtu_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_rtu_t
 
@@ -2779,7 +2779,7 @@ Access Layer/ib_cm_rtu_t

[Structures] Access Layer/ib_cq_create_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cq_create_t
 
@@ -2791,7 +2791,7 @@ Access Layer/ib_cq_create_t { uint32_t size; ib_pfn_comp_cb_t pfn_comp_cb; - cl_waitobj_handle_t h_wait_obj; + cl_waitobj_handle_t h_wait_obj; } ib_cq_create_t;
@@ -2828,7 +2828,7 @@ Access Layer/ib_cq_create_t

[Functions] Access Layer/ib_create_av

-

[top][index]

+

[top][parent][index]

NAME

       ib_create_av
 
@@ -2889,7 +2889,7 @@ Access Layer/ib_create_av

[Functions] Access Layer/ib_create_cq

-

[top][index]

+

[top][parent][index]

NAME

       ib_create_cq
 
@@ -2967,7 +2967,7 @@ Access Layer/ib_create_cq

[Functions] Access Layer/ib_create_ioc

-

[top][index]

+

[top][parent][index]

NAME

       ib_create_ioc
 
@@ -2978,7 +2978,7 @@ Access Layer/ib_create_ioc
AL_EXPORT ib_api_status_t AL_API
 ib_create_ioc(
         IN              const   ib_ca_handle_t                          h_ca,
-        IN              const   ib_ioc_profile_t* const         p_ioc_profile,
+        IN              const   ib_ioc_profile_t* const         p_ioc_profile,
                 OUT                     ib_ioc_handle_t* const          ph_ioc );
 

PARAMETERS

@@ -3014,7 +3014,7 @@ Access Layer/ib_create_ioc manager.

SEE ALSO

-
       ib_destroy_ioc, ib_add_svc_entry, ib_reg_ioc, ib_ioc_profile_t
+
       ib_destroy_ioc, ib_add_svc_entry, ib_reg_ioc, ib_ioc_profile_t
 

@@ -3022,7 +3022,7 @@ Access Layer/ib_create_ioc

[Functions] Access Layer/ib_create_mad_pool

-

[top][index]

+

[top][parent][index]

NAME

       ib_create_mad_pool
 
@@ -3091,7 +3091,7 @@ Access Layer/ib_create_mad_pool

[Functions] Access Layer/ib_create_mw

-

[top][index]

+

[top][parent][index]

NAME

       ib_create_mw
 
@@ -3151,7 +3151,7 @@ Access Layer/ib_create_mw

[Functions] Access Layer/ib_create_qp

-

[top][index]

+

[top][parent][index]

NAME

       ib_create_qp
 
@@ -3255,7 +3255,7 @@ Access Layer/ib_create_qp

[Functions] Access Layer/ib_dealloc_pd

-

[top][index]

+

[top][parent][index]

NAME

       ib_dealloc_pd
 
@@ -3301,7 +3301,7 @@ Access Layer/ib_dealloc_pd

[Functions] Access Layer/ib_dereg_mad_pool

-

[top][index]

+

[top][parent][index]

NAME

       ib_dereg_mad_pool
 
@@ -3344,7 +3344,7 @@ Access Layer/ib_dereg_mad_pool

[Functions] Access Layer/ib_dereg_mr

-

[top][index]

+

[top][parent][index]

NAME

       ib_dereg_mr
 
@@ -3386,7 +3386,7 @@ Access Layer/ib_dereg_mr

[Functions] Access Layer/ib_dereg_pnp

-

[top][index]

+

[top][parent][index]

NAME

       ib_dereg_pnp
 
@@ -3430,7 +3430,7 @@ Access Layer/ib_dereg_pnp

[Functions] Access Layer/ib_dereg_svc

-

[top][index]

+

[top][parent][index]

NAME

       ib_dereg_svc
 
@@ -3481,7 +3481,7 @@ Access Layer/ib_dereg_svc

[Functions] Access Layer/ib_destroy_av

-

[top][index]

+

[top][parent][index]

NAME

       ib_destroy_av
 
@@ -3516,7 +3516,7 @@ Access Layer/ib_destroy_av

[Functions] Access Layer/ib_destroy_cq

-

[top][index]

+

[top][parent][index]

NAME

       ib_destroy_cq
 
@@ -3566,7 +3566,7 @@ Access Layer/ib_destroy_cq

[Functions] Access Layer/ib_destroy_ioc

-

[top][index]

+

[top][parent][index]

NAME

       ib_destroy_ioc
 
@@ -3603,7 +3603,7 @@ Access Layer/ib_destroy_ioc

[Functions] Access Layer/ib_destroy_mad_pool

-

[top][index]

+

[top][parent][index]

NAME

       ib_destroy_mad_pool
 
@@ -3642,7 +3642,7 @@ Access Layer/ib_destroy_mad_pool

[Functions] Access Layer/ib_destroy_mw

-

[top][index]

+

[top][parent][index]

NAME

       ib_destroy_mw
 
@@ -3678,7 +3678,7 @@ Access Layer/ib_destroy_mw

[Functions] Access Layer/ib_destroy_qp

-

[top][index]

+

[top][parent][index]

NAME

       ib_destroy_qp
 
@@ -3723,7 +3723,7 @@ Access Layer/ib_destroy_qp

[Definitions] Access Layer/ib_device_attr_mask_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_device_attr_mask_t
 
@@ -3747,7 +3747,7 @@ Access Layer/ib_device_attr_mask_t

[Structures] Access Layer/ib_dgrm_info_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_dgrm_info_t
 
@@ -3758,7 +3758,7 @@ Access Layer/ib_dgrm_info_t

SYNOPSIS

typedef struct _ib_dgrm_info
 {
-        ib_net64_t                                      port_guid;
+        ib_net64_t                                      port_guid;
         uint32_t                                        qkey;
         uint16_t                                        pkey_index;
 
@@ -3786,7 +3786,7 @@ Access Layer/ib_dgrm_info_t
 

[Structures] Access Layer/ib_drep_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_drep_pdata_t
 
@@ -3809,7 +3809,7 @@ Access Layer/ib_drep_pdata_t

[Structures] Access Layer/ib_dreq_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_dreq_pdata_t
 
@@ -3832,7 +3832,7 @@ Access Layer/ib_dreq_pdata_t

[Functions] Access Layer/ib_force_apm

-

[top][index]

+

[top][parent][index]

NAME

       ib_force_apm
 
@@ -3888,7 +3888,7 @@ Access Layer/ib_force_apm

[Functions] Access Layer/ib_get_ca_by_gid

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_ca_by_gid
 
@@ -3899,8 +3899,8 @@ Access Layer/ib_get_ca_by_gid
AL_EXPORT ib_api_status_t AL_API
 ib_get_ca_by_gid(
         IN                              ib_al_handle_t                          h_al,
-        IN              const   ib_gid_t* const                         p_gid,
-                OUT                     ib_net64_t* const                       p_ca_guid );
+        IN              const   ib_gid_t* const                         p_gid,
+                OUT                     ib_net64_t* const                       p_ca_guid );
 

PARAMETERS

       h_al
@@ -3943,7 +3943,7 @@ Access Layer/ib_get_ca_by_gid
 

[Functions] Access Layer/ib_get_ca_guids

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_ca_guids
 
@@ -3955,7 +3955,7 @@ Access Layer/ib_get_ca_guids
AL_EXPORT ib_api_status_t AL_API
 ib_get_ca_guids(
         IN                              ib_al_handle_t                          h_al,
-                OUT                     ib_net64_t* const                       p_guid_array OPTIONAL,
+                OUT                     ib_net64_t* const                       p_guid_array OPTIONAL,
         IN      OUT                     size_t* const                           p_guid_cnt );
 

PARAMETERS

@@ -4004,7 +4004,7 @@ Access Layer/ib_get_ca_guids

[Functions] Access Layer/ib_get_guid

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_guid
 
@@ -4019,7 +4019,7 @@ Access Layer/ib_get_guid IN const uint32_t index, IN const ib_pnp_class_t device_type, IN const uint64_t attr_mask, - OUT ib_net64_t* const p_guid ); + OUT ib_net64_t* const p_guid );

PARAMETERS

       h_al
@@ -4085,7 +4085,7 @@ Access Layer/ib_get_guid
 

[Functions] Access Layer/ib_get_mad

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_mad
 
@@ -4150,7 +4150,7 @@ Access Layer/ib_get_mad

[Functions] Access Layer/ib_get_mad_buf

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_mad_buf
 
@@ -4185,7 +4185,7 @@ AL_INLINE void* AL_API

[Functions] Access Layer/ib_get_port_by_gid

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_port_by_gid
 
@@ -4196,8 +4196,8 @@ Access Layer/ib_get_port_by_gid
AL_EXPORT ib_api_status_t AL_API
 ib_get_port_by_gid(
         IN                              ib_al_handle_t                          h_al,
-        IN              const   ib_gid_t* const                         p_gid,
-                OUT                     ib_net64_t* const                       p_port_guid );
+        IN              const   ib_gid_t* const                         p_gid,
+                OUT                     ib_net64_t* const                       p_port_guid );
 

PARAMETERS

       h_al
@@ -4240,7 +4240,7 @@ Access Layer/ib_get_port_by_gid
 

[Functions] Access Layer/ib_get_query_node_rec

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_query_node_rec
 
@@ -4254,11 +4254,11 @@ Access Layer/ib_get_query_node_rec IN ib_mad_element_t *p_result_mad, IN uint32_t result_index ) { - ib_sa_mad_t *p_sa_mad; + ib_sa_mad_t *p_sa_mad; CL_ASSERT( p_result_mad ); - p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad ); - CL_ASSERT( p_sa_mad && p_sa_mad->attr_id == IB_MAD_ATTR_NODE_RECORD ); + p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad ); + CL_ASSERT( p_sa_mad && p_sa_mad->attr_id == IB_MAD_ATTR_NODE_RECORD ); return( (ib_node_record_t*)ib_get_query_result( p_result_mad, result_index ) ); @@ -4285,7 +4285,7 @@ Access Layer/ib_get_query_node_rec

[Functions] Access Layer/ib_get_query_path_rec

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_query_path_rec
 
@@ -4294,18 +4294,18 @@ Access Layer/ib_get_query_path_rec ib_query().

SYNOPSIS

-
AL_INLINE ib_path_rec_t* AL_API
+
AL_INLINE ib_path_rec_t* AL_API
 ib_get_query_path_rec(
         IN                              ib_mad_element_t                        *p_result_mad,
         IN                              uint32_t                                        result_index )
 {
-        ib_sa_mad_t             *p_sa_mad;
+        ib_sa_mad_t             *p_sa_mad;
 
         CL_ASSERT( p_result_mad );
-        p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad );
-        CL_ASSERT( p_sa_mad && p_sa_mad->attr_id == IB_MAD_ATTR_PATH_RECORD );
+        p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad );
+        CL_ASSERT( p_sa_mad && p_sa_mad->attr_id == IB_MAD_ATTR_PATH_RECORD );
 
-        return( (ib_path_rec_t*)ib_get_query_result( p_result_mad, result_index ) );
+        return( (ib_path_rec_t*)ib_get_query_result( p_result_mad, result_index ) );
 }
 

PARAMETERS

@@ -4321,7 +4321,7 @@ Access Layer/ib_get_query_path_rec a call to ib_query().

SEE ALSO

-
       ib_query_rec_t, ib_mad_element_t, ib_get_query_result, ib_path_rec_t
+
       ib_query_rec_t, ib_mad_element_t, ib_get_query_result, ib_path_rec_t
 

@@ -4329,7 +4329,7 @@ Access Layer/ib_get_query_path_rec

[Functions] Access Layer/ib_get_query_portinfo_rec

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_query_portinfo_rec
 
@@ -4343,11 +4343,11 @@ Access Layer/ib_get_query_portinfo_rec IN ib_mad_element_t *p_result_mad, IN uint32_t result_index ) { - ib_sa_mad_t *p_sa_mad; + ib_sa_mad_t *p_sa_mad; CL_ASSERT( p_result_mad ); - p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad ); - CL_ASSERT( p_sa_mad && p_sa_mad->attr_id == IB_MAD_ATTR_PORTINFO_RECORD ); + p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad ); + CL_ASSERT( p_sa_mad && p_sa_mad->attr_id == IB_MAD_ATTR_PORTINFO_RECORD ); return( (ib_portinfo_record_t*)ib_get_query_result( p_result_mad, result_index ) ); @@ -4374,7 +4374,7 @@ Access Layer/ib_get_query_portinfo_rec

[Functions] Access Layer/ib_get_query_result

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_query_result
 
@@ -4387,10 +4387,10 @@ Access Layer/ib_get_query_result IN ib_mad_element_t *p_result_mad, IN uint32_t result_index ) { - ib_sa_mad_t *p_sa_mad; + ib_sa_mad_t *p_sa_mad; CL_ASSERT( p_result_mad ); - p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad ); + p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad ); CL_ASSERT( p_sa_mad ); CL_ASSERT( ib_get_attr_size( p_sa_mad->attr_offset ) * (result_index + 1) + IB_SA_MAD_HDR_SIZE <= p_result_mad->size ); @@ -4422,7 +4422,7 @@ Access Layer/ib_get_query_result

[Functions] Access Layer/ib_get_query_svc_rec

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_query_svc_rec
 
@@ -4436,11 +4436,11 @@ Access Layer/ib_get_query_svc_rec IN ib_mad_element_t *p_result_mad, IN uint32_t result_index ) { - ib_sa_mad_t *p_sa_mad; + ib_sa_mad_t *p_sa_mad; CL_ASSERT( p_result_mad ); - p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad ); - CL_ASSERT( p_sa_mad && p_sa_mad->attr_id == IB_MAD_ATTR_SERVICE_RECORD ); + p_sa_mad = (ib_sa_mad_t*)ib_get_mad_buf( p_result_mad ); + CL_ASSERT( p_sa_mad && p_sa_mad->attr_id == IB_MAD_ATTR_SERVICE_RECORD ); return( (ib_service_record_t*)ib_get_query_result( p_result_mad, result_index ) ); @@ -4467,7 +4467,7 @@ Access Layer/ib_get_query_svc_rec

[Functions] Access Layer/ib_get_spl_qp

-

[top][index]

+

[top][parent][index]

NAME

       ib_get_spl_qp
 
@@ -4479,7 +4479,7 @@ Access Layer/ib_get_spl_qp
AL_EXPORT ib_api_status_t AL_API
 ib_get_spl_qp(
         IN              const   ib_pd_handle_t                          h_pd,
-        IN              const   ib_net64_t                                      port_guid,
+        IN              const   ib_net64_t                                      port_guid,
         IN              const   ib_qp_create_t* const           p_qp_create,
         IN              const   void* const                                     qp_context,
         IN              const   ib_pfn_event_cb_t                       pfn_qp_event_cb OPTIONAL,
@@ -4586,7 +4586,7 @@ Access Layer/ib_get_spl_qp
 

[Structures] Access Layer/ib_gid_pair_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_gid_pair_t
 
@@ -4596,8 +4596,8 @@ Access Layer/ib_gid_pair_t

SYNOPSIS

typedef struct _ib_gid_pair
 {
-        ib_gid_t                                        src_gid;
-        ib_gid_t                                        dest_gid;
+        ib_gid_t                                        src_gid;
+        ib_gid_t                                        dest_gid;
 
 }       ib_gid_pair_t;
 
@@ -4612,7 +4612,7 @@ Access Layer/ib_gid_pair_t
       This structure is used to describe the endpoints of a path.
 

SEE ALSO

-
       ib_gid_t
+
       ib_gid_t
 

@@ -4620,7 +4620,7 @@ Access Layer/ib_gid_pair_t

[Structures] Access Layer/ib_guid_pair_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_guid_pair_t
 
@@ -4631,8 +4631,8 @@ Access Layer/ib_guid_pair_t

SYNOPSIS

typedef struct _ib_guid_pair
 {
-        ib_net64_t                                      src_guid;
-        ib_net64_t                                      dest_guid;
+        ib_net64_t                                      src_guid;
+        ib_net64_t                                      dest_guid;
 
 }       ib_guid_pair_t;
 
@@ -4656,7 +4656,7 @@ Access Layer/ib_guid_pair_t

[Functions] Access Layer/ib_init_dgrm_svc

-

[top][index]

+

[top][parent][index]

NAME

       ib_init_dgrm_svc
 
@@ -4724,7 +4724,7 @@ Access Layer/ib_init_dgrm_svc

[Functions] Access Layer/ib_join_mcast

-

[top][index]

+

[top][parent][index]

NAME

       ib_join_mcast
 
@@ -4808,7 +4808,7 @@ Access Layer/ib_join_mcast

[Structures] Access Layer/ib_lap_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_lap_pdata_t
 
@@ -4831,7 +4831,7 @@ Access Layer/ib_lap_pdata_t

[Functions] Access Layer/ib_leave_mcast

-

[top][index]

+

[top][parent][index]

NAME

       ib_leave_mcast
 
@@ -4879,7 +4879,7 @@ Access Layer/ib_leave_mcast

[Structures] Access Layer/ib_lid_pair_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_lid_pair_t
 
@@ -4889,8 +4889,8 @@ Access Layer/ib_lid_pair_t

SYNOPSIS

typedef struct _ib_lid_pair
 {
-        ib_net16_t                                      src_lid;
-        ib_net16_t                                      dest_lid;
+        ib_net16_t                                      src_lid;
+        ib_net16_t                                      dest_lid;
 
 }       ib_lid_pair_t;
 
@@ -4910,7 +4910,7 @@ Access Layer/ib_lid_pair_t

[Structures] Access Layer/ib_listen_err_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_listen_err_rec_t
 
@@ -4948,7 +4948,7 @@ Access Layer/ib_listen_err_rec_t

[Definitions] Access Layer/ib_listen_info_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_listen_info_t
 
@@ -4970,7 +4970,7 @@ Access Layer/ib_listen_info_t

[Functions] Access Layer/ib_local_mad

-

[top][index]

+

[top][parent][index]

NAME

       ib_local_mad
 
@@ -5030,7 +5030,7 @@ Access Layer/ib_local_mad

[Structures] Access Layer/ib_mad_element_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_mad_element_t
 
@@ -5046,15 +5046,15 @@ Access Layer/ib_mad_element_t const void* __ptr64 context2; /* Request/completion data. */ - ib_mad_t* __ptr64 p_mad_buf; + ib_mad_t* __ptr64 p_mad_buf; uint32_t size; uint32_t immediate_data; - ib_net32_t remote_qp; + ib_net32_t remote_qp; /* Send request information. */ ib_av_handle_t h_av; ib_send_opt_t send_opt; - ib_net32_t remote_qkey; + ib_net32_t remote_qkey; boolean_t resp_expected; uint32_t timeout_ms; uint32_t retry_cnt; @@ -5063,11 +5063,11 @@ Access Layer/ib_mad_element_t /* Completion information. */ ib_wc_status_t status; boolean_t grh_valid; - ib_grh_t* __ptr64 p_grh; + ib_grh_t* __ptr64 p_grh; /* Completed receive data or send request information if h_av is NULL. */ uint32_t recv_opt; - ib_net16_t remote_lid; + ib_net16_t remote_lid; uint8_t remote_sl; uint16_t pkey_index; uint8_t path_bits; @@ -5217,7 +5217,7 @@ Access Layer/ib_mad_element_t

[Structures] Access Layer/ib_mad_svc_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_mad_svc_t
 
@@ -5311,7 +5311,7 @@ Access Layer/ib_mad_svc_t

[Definitions] Access Layer/ib_mad_svc_type_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_mad_svc_type_t
 
@@ -5354,7 +5354,7 @@ Access Layer/ib_mad_svc_type_t

[Structures] Access Layer/ib_mcast_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_mcast_rec_t
 
@@ -5366,10 +5366,10 @@ Access Layer/ib_mcast_rec_t { const void* __ptr64 mcast_context; ib_api_status_t status; - ib_net16_t error_status; + ib_net16_t error_status; ib_mcast_handle_t h_mcast; - ib_member_rec_t* __ptr64 p_member_rec; + ib_member_rec_t* __ptr64 p_member_rec; } ib_mcast_rec_t;
@@ -5407,7 +5407,7 @@ Access Layer/ib_mcast_rec_t

[Structures] Access Layer/ib_mcast_req_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_mcast_req_t
 
@@ -5418,7 +5418,7 @@ Access Layer/ib_mcast_req_t
typedef struct _ib_mcast_req
 {
         boolean_t                                       create;
-        ib_member_rec_t                         member_rec;
+        ib_member_rec_t                         member_rec;
 
         const void* __ptr64                     mcast_context;
         ib_pfn_mcast_cb_t                       pfn_mcast_cb;
@@ -5427,7 +5427,7 @@ Access Layer/ib_mcast_req_t
         uint32_t                                        retry_cnt;
         ib_al_flags_t                           flags;
 
-        ib_net64_t                                      port_guid;
+        ib_net64_t                                      port_guid;
         uint16_t                                        pkey_index;
 
 }       ib_mcast_req_t;
@@ -5478,7 +5478,7 @@ Access Layer/ib_mcast_req_t
        creating a new multicast group.
 

SEE ALSO

-
       ib_join_mcast, ib_pfn_mcast_cb_t, ib_gid_t
+
       ib_join_mcast, ib_pfn_mcast_cb_t, ib_gid_t
 

@@ -5486,7 +5486,7 @@ Access Layer/ib_mcast_req_t

[Functions] Access Layer/ib_modify_av

-

[top][index]

+

[top][parent][index]

NAME

       ib_modify_av
 
@@ -5534,7 +5534,7 @@ Access Layer/ib_modify_av

[Functions] Access Layer/ib_modify_ca

-

[top][index]

+

[top][parent][index]

NAME

       ib_modify_ca
 
@@ -5596,7 +5596,7 @@ Access Layer/ib_modify_ca

[Functions] Access Layer/ib_modify_cq

-

[top][index]

+

[top][parent][index]

NAME

       ib_modify_cq
 
@@ -5658,7 +5658,7 @@ Access Layer/ib_modify_cq

[Functions] Access Layer/ib_modify_qp

-

[top][index]

+

[top][parent][index]

NAME

       ib_modify_qp
 
@@ -5722,7 +5722,7 @@ Access Layer/ib_modify_qp

[Structures] Access Layer/ib_mra_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_mra_pdata_t
 
@@ -5745,7 +5745,7 @@ Access Layer/ib_mra_pdata_t

[Functions] Access Layer/ib_open_al

-

[top][index]

+

[top][parent][index]

NAME

       ib_open_al
 
@@ -5789,7 +5789,7 @@ Access Layer/ib_open_al

[Functions] Access Layer/ib_open_ca

-

[top][index]

+

[top][parent][index]

NAME

       ib_open_ca
 
@@ -5801,7 +5801,7 @@ Access Layer/ib_open_ca
AL_EXPORT ib_api_status_t AL_API
 ib_open_ca(
         IN              const   ib_al_handle_t                          h_al,
-        IN              const   ib_net64_t                                      ca_guid,
+        IN              const   ib_net64_t                                      ca_guid,
         IN              const   ib_pfn_event_cb_t                       pfn_ca_event_cb OPTIONAL,
         IN              const   void* const                                     ca_context,
                 OUT                     ib_ca_handle_t* const           ph_ca );
@@ -5854,7 +5854,7 @@ Access Layer/ib_open_ca
 

[Functions] Access Layer/ib_peek_cq

-

[top][index]

+

[top][parent][index]

NAME

       ib_peek_cq
 
@@ -5902,7 +5902,7 @@ Access Layer/ib_peek_cq

[Functions] Access Layer/ib_pfn_cm_apr_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_cm_apr_cb_t
 
@@ -5936,7 +5936,7 @@ Access Layer/ib_pfn_cm_apr_cb_t

[Functions] Access Layer/ib_pfn_cm_drep_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_cm_drep_cb_t
 
@@ -5970,7 +5970,7 @@ Access Layer/ib_pfn_cm_drep_cb_t

[Functions] Access Layer/ib_pfn_cm_dreq_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_cm_dreq_cb_t
 
@@ -6006,7 +6006,7 @@ Access Layer/ib_pfn_cm_dreq_cb_t

[Functions] Access Layer/ib_pfn_cm_lap_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_cm_lap_cb_t
 
@@ -6041,7 +6041,7 @@ Access Layer/ib_pfn_cm_lap_cb_t

[Functions] Access Layer/ib_pfn_cm_mra_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_cm_mra_cb_t
 
@@ -6076,7 +6076,7 @@ Access Layer/ib_pfn_cm_mra_cb_t

[Functions] Access Layer/ib_pfn_cm_rej_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_cm_rej_cb_t
 
@@ -6110,7 +6110,7 @@ Access Layer/ib_pfn_cm_rej_cb_t

[Functions] Access Layer/ib_pfn_cm_rep_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_cm_rep_cb_t
 
@@ -6157,7 +6157,7 @@ Access Layer/ib_pfn_cm_rep_cb_t

[Functions] Access Layer/ib_pfn_cm_req_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_cm_req_cb_t
 
@@ -6198,7 +6198,7 @@ Access Layer/ib_pfn_cm_req_cb_t

[Functions] Access Layer/ib_pfn_cm_rtu_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_cm_rtu_cb_t
 
@@ -6236,7 +6236,7 @@ Access Layer/ib_pfn_cm_rtu_cb_t

[Functions] Access Layer/ib_pfn_comp_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_comp_cb_t
 
@@ -6272,7 +6272,7 @@ Access Layer/ib_pfn_comp_cb_t

[Functions] Access Layer/ib_pfn_destroy_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_destroy_cb_t
 
@@ -6312,7 +6312,7 @@ Access Layer/ib_pfn_destroy_cb_t

[Functions] Access Layer/ib_pfn_event_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_event_cb_t
 
@@ -6342,7 +6342,7 @@ Access Layer/ib_pfn_event_cb_t

[Functions] Access Layer/ib_pfn_listen_err_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_listen_err_cb_t
 
@@ -6372,7 +6372,7 @@ Access Layer/ib_pfn_listen_err_cb_t

[Functions] Access Layer/ib_pfn_mad_comp_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_mad_comp_cb_t
 
@@ -6422,7 +6422,7 @@ Access Layer/ib_pfn_mad_comp_cb_t

[Functions] Access Layer/ib_pfn_mcast_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_mcast_cb_t
 
@@ -6453,7 +6453,7 @@ Access Layer/ib_pfn_mcast_cb_t

[Functions] Access Layer/ib_pfn_pnp_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_pnp_cb_t
 
@@ -6507,7 +6507,7 @@ Access Layer/ib_pfn_pnp_cb_t

[Functions] Access Layer/ib_pfn_query_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_query_cb_t
 
@@ -6543,7 +6543,7 @@ Access Layer/ib_pfn_query_cb_t

[Functions] Access Layer/ib_pfn_reg_svc_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_reg_svc_cb_t
 
@@ -6576,7 +6576,7 @@ Access Layer/ib_pfn_reg_svc_cb_t

[Functions] Access Layer/ib_pfn_report_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_report_cb_t
 
@@ -6617,7 +6617,7 @@ Access Layer/ib_pfn_report_cb_t

[Functions] Access Layer/ib_pfn_sub_cb_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pfn_sub_cb_t
 
@@ -6655,7 +6655,7 @@ Access Layer/ib_pfn_sub_cb_t

[Structures] Access Layer/ib_pnp_ca_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pnp_ca_rec_t
 
@@ -6705,7 +6705,7 @@ Access Layer/ib_pnp_ca_rec_t

[Definitions] Access Layer/ib_pnp_class_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pnp_class_t
 
@@ -6773,7 +6773,7 @@ typedef uint32_t ib_pnp_class_t;

[Definitions] Access Layer/ib_pnp_event_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pnp_event_t
 
@@ -6908,7 +6908,7 @@ typedef uint32_t ib_pnp_event_t;

[Structures] Access Layer/ib_pnp_ioc_path_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pnp_ioc_path_rec_t
 
@@ -6922,7 +6922,7 @@ Access Layer/ib_pnp_ioc_path_rec_t ib_pnp_rec_t pnp_rec; net64_t ca_guid; net64_t port_guid; - ib_path_rec_t path; + ib_path_rec_t path; } ib_pnp_ioc_path_rec_t;
@@ -6969,7 +6969,7 @@ Access Layer/ib_pnp_ioc_path_rec_t

[Structures] Access Layer/ib_pnp_ioc_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pnp_ioc_rec_t
 
@@ -6983,7 +6983,7 @@ Access Layer/ib_pnp_ioc_rec_t ib_pnp_rec_t pnp_rec; net64_t ca_guid; ib_ioc_info_t info; - ib_svc_entry_t svc_entry_array[1]; + ib_svc_entry_t svc_entry_array[1]; } ib_pnp_ioc_rec_t;
@@ -7030,7 +7030,7 @@ Access Layer/ib_pnp_ioc_rec_t

[Structures] Access Layer/ib_pnp_iou_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pnp_iou_rec_t
 
@@ -7041,6 +7041,7 @@ Access Layer/ib_pnp_iou_rec_t
typedef struct _ib_pnp_iou_rec
 {
         ib_pnp_rec_t                            pnp_rec;
+        net64_t                                         guid;
         net64_t                                         ca_guid;
         net64_t                                         chassis_guid;
         uint8_t                                         slot;
@@ -7112,7 +7113,7 @@ Access Layer/ib_pnp_iou_rec_t
 

[Structures] Access Layer/ib_pnp_port_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pnp_port_rec_t
 
@@ -7168,7 +7169,7 @@ Access Layer/ib_pnp_port_rec_t

[Structures] Access Layer/ib_pnp_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pnp_rec_t
 
@@ -7187,7 +7188,8 @@ Access Layer/ib_pnp_rec_t void* __ptr64 pnp_context; void* __ptr64 context; - ib_net64_t guid; + ib_net64_t guid; + ib_net64_t ca_guid; } ib_pnp_rec_t;
@@ -7220,6 +7222,9 @@ Access Layer/ib_pnp_rec_t guid The GUID of the adapter, port, IOU, or IOC for which the PnP event occurred. + + ca_guid + The GUID of the HCA

NOTES

       This structure is returned to the user to notify them of: the addition
@@ -7249,7 +7254,7 @@ Access Layer/ib_pnp_rec_t
 

[Structures] Access Layer/ib_pnp_req_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pnp_req_t
 
@@ -7294,7 +7299,7 @@ Access Layer/ib_pnp_req_t

[Functions] Access Layer/ib_poll_cq

-

[top][index]

+

[top][parent][index]

NAME

       ib_poll_cq
 
@@ -7354,7 +7359,7 @@ Access Layer/ib_poll_cq

[Functions] Access Layer/ib_post_recv

-

[top][index]

+

[top][parent][index]

NAME

       ib_post_recv
 
@@ -7415,7 +7420,7 @@ Access Layer/ib_post_recv

[Functions] Access Layer/ib_post_send

-

[top][index]

+

[top][parent][index]

NAME

       ib_post_send
 
@@ -7482,7 +7487,7 @@ Access Layer/ib_post_send

[Functions] Access Layer/ib_put_mad

-

[top][index]

+

[top][parent][index]

NAME

       ib_put_mad
 
@@ -7517,7 +7522,7 @@ Access Layer/ib_put_mad

[Functions] Access Layer/ib_query

-

[top][index]

+

[top][parent][index]

NAME

       ib_query
 
@@ -7582,7 +7587,7 @@ Access Layer/ib_query

[Functions] Access Layer/ib_query_av

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_av
 
@@ -7628,7 +7633,7 @@ Access Layer/ib_query_av

[Functions] Access Layer/ib_query_ca

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_ca
 
@@ -7692,7 +7697,7 @@ Access Layer/ib_query_ca

[Functions] Access Layer/ib_query_ca_by_guid

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_ca_by_guid
 
@@ -7703,7 +7708,7 @@ Access Layer/ib_query_ca_by_guid
AL_EXPORT ib_api_status_t AL_API
 ib_query_ca_by_guid(
         IN              const   ib_al_handle_t                          h_al,
-        IN              const   ib_net64_t                                      ca_guid,
+        IN              const   ib_net64_t                                      ca_guid,
                 OUT                     ib_ca_attr_t* const                     p_ca_attr OPTIONAL,
         IN      OUT                     uint32_t* const                         p_size );
 
@@ -7763,7 +7768,7 @@ Access Layer/ib_query_ca_by_guid

[Functions] Access Layer/ib_query_cq

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_cq
 
@@ -7803,7 +7808,7 @@ Access Layer/ib_query_cq

[Functions] Access Layer/ib_query_mr

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_mr
 
@@ -7847,7 +7852,7 @@ Access Layer/ib_query_mr

[Functions] Access Layer/ib_query_mw

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_mw
 
@@ -7895,7 +7900,7 @@ Access Layer/ib_query_mw

[Functions] Access Layer/ib_query_qp

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_qp
 
@@ -7939,7 +7944,7 @@ Access Layer/ib_query_qp

[Structures] Access Layer/ib_query_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_rec_t
 
@@ -8001,7 +8006,7 @@ Access Layer/ib_query_rec_t

[Structures] Access Layer/ib_query_req_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_req_t
 
@@ -8014,7 +8019,7 @@ Access Layer/ib_query_req_t { ib_query_type_t query_type; const void* __ptr64 p_query_input; - ib_net64_t port_guid; + ib_net64_t port_guid; uint32_t timeout_ms; uint32_t retry_cnt; @@ -8083,7 +8088,7 @@ Access Layer/ib_query_req_t

[Definitions] Access Layer/ib_query_type_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_query_type_t
 
@@ -8126,17 +8131,17 @@ Access Layer/ib_query_type_t IB_QUERY_SVC_REC_BY_ID Query for service records based on the service ID. Queries of - this type should reference an ib_net64_t value that indicates the + this type should reference an ib_net64_t value that indicates the ID of the service being requested. IB_QUERY_NODE_REC_BY_NODE_GUID Query for node information based on the node's GUID. Queries of - this type should reference an ib_net64_t value that indicates the + this type should reference an ib_net64_t value that indicates the GUID of the node being requested. IB_QUERY_PORT_REC_BY_LID Query for port information based on the port's base LID. Queries of - this type should reference an ib_net16_t value that indicates the + this type should reference an ib_net16_t value that indicates the base LID of the port being requested. IB_QUERY_PATH_REC_BY_PORT_GUIDS @@ -8170,7 +8175,7 @@ Access Layer/ib_query_type_t

[Functions] Access Layer/ib_rearm_cq

-

[top][index]

+

[top][parent][index]

NAME

       ib_rearm_cq
 
@@ -8213,7 +8218,7 @@ Access Layer/ib_rearm_cq

[Functions] Access Layer/ib_rearm_n_cq

-

[top][index]

+

[top][parent][index]

NAME

       ib_rearm_n_cq
 
@@ -8267,7 +8272,7 @@ Access Layer/ib_rearm_n_cq

[Functions] Access Layer/ib_reg_ioc

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_ioc
 
@@ -8313,7 +8318,7 @@ Access Layer/ib_reg_ioc

[Functions] Access Layer/ib_reg_mad_pool

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_mad_pool
 
@@ -8374,7 +8379,7 @@ Access Layer/ib_reg_mad_pool

[Functions] Access Layer/ib_reg_mad_svc

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_mad_svc
 
@@ -8434,7 +8439,7 @@ Access Layer/ib_reg_mad_svc

[Functions] Access Layer/ib_reg_mem

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_mem
 
@@ -8508,7 +8513,7 @@ Access Layer/ib_reg_mem

[Functions] Access Layer/ib_reg_phys

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_phys
 
@@ -8590,7 +8595,7 @@ Access Layer/ib_reg_phys

[Functions] Access Layer/ib_reg_pnp

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_pnp
 
@@ -8655,7 +8660,7 @@ Access Layer/ib_reg_pnp

[Functions] Access Layer/ib_reg_shared

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_shared
 
@@ -8745,7 +8750,7 @@ Access Layer/ib_reg_shared

[Functions] Access Layer/ib_reg_shmid

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_shmid
 
@@ -8836,7 +8841,7 @@ Access Layer/ib_reg_shmid

[Functions] Access Layer/ib_reg_svc

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_svc
 
@@ -8902,7 +8907,7 @@ Access Layer/ib_reg_svc

[Structures] Access Layer/ib_reg_svc_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       _ib_reg_svc_rec_t
 
@@ -8916,7 +8921,7 @@ Access Layer/ib_reg_svc_rec_t const void* __ptr64 svc_context; ib_reg_svc_handle_t h_reg_svc; ib_api_status_t req_status; - ib_net16_t resp_status; + ib_net16_t resp_status; ib_service_record_t svc_rec; } ib_reg_svc_rec_t; @@ -8955,7 +8960,7 @@ Access Layer/ib_reg_svc_rec_t

[Structures] Access Layer/ib_reg_svc_req_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_reg_svc_req_t
 
@@ -8967,14 +8972,14 @@ Access Layer/ib_reg_svc_req_t
typedef struct _ib_reg_svc_req
 {
         ib_service_record_t                     svc_rec;
-        ib_net64_t                                      port_guid;
+        ib_net64_t                                      port_guid;
 
         uint32_t                                        timeout_ms;
         uint32_t                                        retry_cnt;
         ib_al_flags_t                           flags;
 
         const void                                      *svc_context;
-        ib_net64_t                                      svc_data_mask;
+        ib_net64_t                                      svc_data_mask;
 
         ib_pfn_reg_svc_cb_t                     pfn_reg_svc_cb;
 
@@ -9032,7 +9037,7 @@ Access Layer/ib_reg_svc_req_t
 

[Structures] Access Layer/ib_rej_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_rej_pdata_t
 
@@ -9055,7 +9060,7 @@ Access Layer/ib_rej_pdata_t

[Functions] Access Layer/ib_reject_ioc

-

[top][index]

+

[top][parent][index]

NAME

       ib_reject_ioc
 
@@ -9110,7 +9115,7 @@ Access Layer/ib_reject_ioc

[Functions] Access Layer/ib_remove_svc_entry

-

[top][index]

+

[top][parent][index]

NAME

       ib_remove_svc_entry
 
@@ -9147,7 +9152,7 @@ Access Layer/ib_remove_svc_entry

[Structures] Access Layer/ib_rep_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_rep_pdata_t
 
@@ -9170,7 +9175,7 @@ Access Layer/ib_rep_pdata_t

[Structures] Access Layer/ib_report_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_report_rec_t
 
@@ -9209,7 +9214,7 @@ Access Layer/ib_report_rec_t

[Structures] Access Layer/ib_req_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_req_pdata_t
 
@@ -9232,7 +9237,7 @@ Access Layer/ib_req_pdata_t

[Functions] Access Layer/ib_rereg_mem

-

[top][index]

+

[top][parent][index]

NAME

       ib_rereg_mem
 
@@ -9320,7 +9325,7 @@ Access Layer/ib_rereg_mem

[Functions] Access Layer/ib_rereg_phys

-

[top][index]

+

[top][parent][index]

NAME

       ib_rereg_phys
 
@@ -9414,7 +9419,7 @@ Access Layer/ib_rereg_phys

[Structures] Access Layer/ib_rtu_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_rtu_pdata_t
 
@@ -9437,7 +9442,7 @@ Access Layer/ib_rtu_pdata_t

[Functions] Access Layer/ib_send_mad

-

[top][index]

+

[top][parent][index]

NAME

       ib_send_mad
 
@@ -9505,7 +9510,7 @@ Access Layer/ib_send_mad

[Structures] Access Layer/ib_shmid_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_shmid_t
 
@@ -9524,7 +9529,7 @@ Access Layer/ib_shmid_t

[Structures] Access Layer/ib_sidr_rep_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_sidr_rep_pdata_t
 
@@ -9547,7 +9552,7 @@ Access Layer/ib_sidr_rep_pdata_t

[Structures] Access Layer/ib_sidr_req_pdata_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_sidr_req_pdata_t
 
@@ -9570,7 +9575,7 @@ Access Layer/ib_sidr_req_pdata_t

[Structures] Access Layer/ib_sub_rec_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_sub_rec_t
 
@@ -9619,7 +9624,7 @@ Access Layer/ib_sub_rec_t

[Structures] Access Layer/ib_sub_req_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_sub_req_t
 
@@ -9632,7 +9637,7 @@ Access Layer/ib_sub_req_t { ib_svc_name_t* __ptr64 p_class_mgr_name; ib_inform_info_t* __ptr64 p_inform_info; - ib_net64_t port_guid; + ib_net64_t port_guid; uint32_t timeout_ms; uint32_t retry_cnt; @@ -9705,7 +9710,7 @@ Access Layer/ib_sub_req_t

[Functions] Access Layer/ib_subscribe

-

[top][index]

+

[top][parent][index]

NAME

       ib_subscribe
 
@@ -9768,7 +9773,7 @@ Access Layer/ib_subscribe

[Functions] Access Layer/ib_sync_destroy

-

[top][index]

+

[top][parent][index]

NAME

       ib_sync_destroy
 
@@ -9777,9 +9782,7 @@ Access Layer/ib_sync_destroy object.

SYNOPSIS

-
AL_EXPORT void AL_API
-ib_sync_destroy(
-        IN                              void                                            *context );
+
static const ib_pfn_destroy_cb_t ib_sync_destroy = (ib_pfn_destroy_cb_t)-1i64;
 

PARAMETERS

       Not Applicable.
@@ -9798,7 +9801,7 @@ Access Layer/ib_sync_destroy
 

[Functions] Access Layer/ib_unsubscribe

-

[top][index]

+

[top][parent][index]

NAME

       ib_unsubscribe
 
@@ -9855,7 +9858,7 @@ Access Layer/ib_unsubscribe

[Structures] Access Layer/ib_user_query_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_user_query_t
 
@@ -9866,9 +9869,9 @@ Access Layer/ib_user_query_t
typedef struct _ib_user_query
 {
         uint8_t                                 method;
-        ib_net16_t                              attr_id;
+        ib_net16_t                              attr_id;
         uint32_t                                attr_size;
-        ib_net64_t                              comp_mask;
+        ib_net64_t                              comp_mask;
         void* __ptr64                   p_attr;
 
 }       ib_user_query_t;
@@ -9906,7 +9909,7 @@ Access Layer/ib_user_query_t
 

[Functions] Access Layer/mlnx_create_fmr

-

[top][index]

+

[top][parent][index]

NAME

       mlnx_create_fmr
 
@@ -9973,7 +9976,7 @@ Access Layer/mlnx_create_fmr

[Functions] Access Layer/mlnx_destroy_fmr

-

[top][index]

+

[top][parent][index]

NAME

       mlnx_destroy_fmr
 
@@ -10031,7 +10034,7 @@ Access Layer/mlnx_destroy_fmr

[Functions] Access Layer/mlnx_map_fmr

-

[top][index]

+

[top][parent][index]

NAME

       mlnx_map_fmr
 
@@ -10108,7 +10111,7 @@ mlnx_map_phys_fmr(

[Functions] Access Layer/mlnx_unmap_fmr

-

[top][index]

+

[top][parent][index]

NAME

       mlnx_unmap_fmr
 
diff --git a/trunk/docs/iba/ib_al_ioctl_h.html b/trunk/docs/iba/ib_al_ioctl_h.html index 3b578973..102b5e1d 100644 --- a/trunk/docs/iba/ib_al_ioctl_h.html +++ b/trunk/docs/iba/ib_al_ioctl_h.html @@ -2,16 +2,16 @@ -./inc_doc/iba/ib_al_ioctl_h.html +./inc_docs/iba/ib_al_ioctl_h.html -Generated from ./inc/iba/ib_al_ioctl.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/iba/ib_al_ioctl.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Structures] +

[Structures] User-mode Access Layer/ual_alloc_pd_ioctl_t

[top][index]

@@ -27,7 +27,7 @@ User-mode Access Layer/ual_alloc_pd_ioctl_t

{ struct _ual_alloc_pd_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_ca; ib_pd_type_t type; void* __ptr64 context; @@ -35,7 +35,7 @@ User-mode Access Layer/ual_alloc_pd_ioctl_t } in; struct _ual_alloc_pd_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; uint64_t h_pd; @@ -67,7 +67,7 @@ User-mode Access Layer/ual_alloc_pd_ioctl_t

-

[Structures] +

[Structures] User-mode Access Layer/ual_attach_mcast_ioctl_t

[top][index]

@@ -83,15 +83,15 @@ User-mode Access Layer/ual_attach_mcast_ioctl_t

{ struct _ual_attach_mcast_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_qp; - ib_gid_t mgid; - ib_net16_t mlid; + ib_gid_t mgid; + ib_net16_t mlid; } in; struct _ual_attach_mcast_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; uint64_t h_attach; @@ -126,7 +126,7 @@ User-mode Access Layer/ual_attach_mcast_ioctl_t

-

[Structures] +

[Structures] User-mode Access Layer/ual_bind_file_ioctl_t

[top][index]

@@ -157,7 +157,7 @@ User-mode Access Layer/ual_bind_file_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_bind_mw_ioctl_t

[top][index]

@@ -206,7 +206,7 @@ User-mode Access Layer/ual_bind_mw_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cancel_mad_ioctl_t

[top][index]

@@ -247,7 +247,7 @@ User-mode Access Layer/ual_cancel_mad_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cancel_sa_req_ioctl_t

[top][index]

@@ -272,7 +272,7 @@ User-mode Access Layer/ual_cancel_sa_req_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_apr_ioctl_t

[top][index]

@@ -314,7 +314,7 @@ User-mode Access Layer/ual_cep_apr_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_drep_ioctl_t

[top][index]

@@ -344,7 +344,7 @@ User-mode Access Layer/ual_cep_drep_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_dreq_ioctl_t

[top][index]

@@ -371,7 +371,7 @@ User-mode Access Layer/ual_cep_dreq_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_get_rtr_ioctl_t

[top][index]

@@ -400,7 +400,7 @@ User-mode Access Layer/ual_cep_get_rtr_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_get_rts_ioctl_t

[top][index]

@@ -429,7 +429,7 @@ User-mode Access Layer/ual_cep_get_rts_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_get_timewait_ioctl_t

[top][index]

@@ -458,7 +458,7 @@ User-mode Access Layer/ual_cep_get_timewait_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_handoff_ioctl_t

[top][index]

@@ -499,7 +499,7 @@ User-mode Access Layer/ual_cep_handoff_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_lap_ioctl_t

[top][index]

@@ -515,7 +515,7 @@ User-mode Access Layer/ual_cep_lap_ioctl_t

{ net32_t cid; ib_cm_lap_t cm_lap; - ib_path_rec_t alt_path; + ib_path_rec_t alt_path; uint8_t pdata[IB_LAP_PDATA_SIZE]; } ual_cep_lap_ioctl_t; @@ -530,7 +530,7 @@ User-mode Access Layer/ual_cep_lap_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_listen_ioctl_t

[top][index]

@@ -561,7 +561,7 @@ User-mode Access Layer/ual_cep_listen_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_mra_ioctl_t

[top][index]

@@ -591,7 +591,7 @@ User-mode Access Layer/ual_cep_mra_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_poll_ioctl_t

[top][index]

@@ -609,8 +609,8 @@ User-mode Access Layer/ual_cep_poll_ioctl_t

void* __ptr64 context; net32_t new_cid; ib_mad_element_t element; - ib_grh_t grh; - uint8_t mad_buf[MAD_BLOCK_SIZE]; + ib_grh_t grh; + uint8_t mad_buf[MAD_BLOCK_SIZE]; } ual_cep_poll_ioctl_t;
@@ -628,7 +628,7 @@ User-mode Access Layer/ual_cep_poll_ioctl_t

-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_rej_ioctl_t

[top][index]

@@ -674,7 +674,7 @@ User-mode Access Layer/ual_cep_rej_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_rep_ioctl_t

[top][index]

@@ -721,7 +721,7 @@ User-mode Access Layer/ual_cep_rep_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cep_rtu_ioctl_t

[top][index]

@@ -754,7 +754,7 @@ User-mode Access Layer/ual_cep_rtu_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_ci_call_ioctl_t

[top][index]

@@ -770,7 +770,7 @@ User-mode Access Layer/ual_ci_call_ioctl_t

{ struct _ual_ci_call_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_ci_op_t ci_op; uint64_t h_ca; uint32_t num_handles; @@ -779,7 +779,7 @@ User-mode Access Layer/ual_ci_call_ioctl_t } in; struct _ual_ci_call_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_ci_op_t ci_op; ib_api_status_t status; @@ -822,7 +822,7 @@ User-mode Access Layer/ual_ci_call_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_close_ca_ioctl_t

[top][index]

@@ -859,7 +859,7 @@ User-mode Access Layer/ual_close_ca_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_cm_req_ioctl_t

[top][index]

@@ -877,7 +877,7 @@ User-mode Access Layer/ual_cm_req_ioctl_t

{ net32_t cid; ib_cm_req_t cm_req; - ib_path_rec_t paths[2]; + ib_path_rec_t paths[2]; uint8_t pdata[IB_REQ_PDATA_SIZE]; uint8_t compare[IB_REQ_PDATA_SIZE]; @@ -910,7 +910,7 @@ User-mode Access Layer/ual_cm_req_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_create_av_ioctl_t

[top][index]

@@ -926,14 +926,14 @@ User-mode Access Layer/ual_create_av_ioctl_t

{ struct _ual_create_av_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_pd; ib_av_attr_t attr; } in; struct _ual_create_av_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; uint64_t h_av; @@ -965,7 +965,7 @@ User-mode Access Layer/ual_create_av_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_create_cep_ioctl_t

[top][index]

@@ -994,7 +994,7 @@ User-mode Access Layer/ual_create_cep_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_create_cq_ioctl_t

[top][index]

@@ -1010,7 +1010,7 @@ User-mode Access Layer/ual_create_cq_ioctl_t

{ struct _ual_create_cq_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_ca; void* __ptr64 h_wait_obj; void* __ptr64 context; @@ -1020,7 +1020,7 @@ User-mode Access Layer/ual_create_cq_ioctl_t } in; struct _ual_create_cq_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; uint64_t h_cq; uint32_t size; @@ -1063,7 +1063,7 @@ User-mode Access Layer/ual_create_cq_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_create_mw_ioctl_t

[top][index]

@@ -1079,13 +1079,13 @@ User-mode Access Layer/ual_create_mw_ioctl_t

{ struct _ual_create_mw_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_pd; } in; struct _ual_create_mw_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; net32_t rkey; uint64_t h_mw; @@ -1119,7 +1119,7 @@ User-mode Access Layer/ual_create_mw_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_create_qp_ioctl_t

[top][index]

@@ -1135,7 +1135,7 @@ User-mode Access Layer/ual_create_qp_ioctl_t

{ struct _ual_create_qp_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_pd; ib_qp_create_t qp_create; void* __ptr64 context; @@ -1144,7 +1144,7 @@ User-mode Access Layer/ual_create_qp_ioctl_t } in; struct _ual_create_qp_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; ib_qp_attr_t attr; uint64_t h_qp; @@ -1187,7 +1187,7 @@ User-mode Access Layer/ual_create_qp_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_dealloc_pd_ioctl_t

[top][index]

@@ -1224,7 +1224,7 @@ User-mode Access Layer/ual_dealloc_pd_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_dereg_mad_pool_ioctl_t

[top][index]

@@ -1263,7 +1263,7 @@ User-mode Access Layer/ual_dereg_mad_pool_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_dereg_mad_svc_ioctl_t

[top][index]

@@ -1300,7 +1300,7 @@ User-mode Access Layer/ual_dereg_mad_svc_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_dereg_mr_ioctl_t

[top][index]

@@ -1337,7 +1337,7 @@ User-mode Access Layer/ual_dereg_mr_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_dereg_pnp_ioctl_t

[top][index]

@@ -1365,7 +1365,7 @@ User-mode Access Layer/ual_dereg_pnp_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_destroy_av_ioctl_t

[top][index]

@@ -1402,7 +1402,7 @@ User-mode Access Layer/ual_destroy_av_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_destroy_cq_ioctl_t

[top][index]

@@ -1439,7 +1439,7 @@ User-mode Access Layer/ual_destroy_cq_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_destroy_mw_ioctl_t

[top][index]

@@ -1476,7 +1476,7 @@ User-mode Access Layer/ual_destroy_mw_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_destroy_qp_ioctl_t

[top][index]

@@ -1513,7 +1513,7 @@ User-mode Access Layer/ual_destroy_qp_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_detach_mcast_ioctl_t

[top][index]

@@ -1550,7 +1550,7 @@ User-mode Access Layer/ual_detach_mcast_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_force_apm_ioctl_t

[top][index]

@@ -1587,7 +1587,7 @@ User-mode Access Layer/ual_force_apm_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_get_uvp_name_t

[top][index]

@@ -1603,7 +1603,7 @@ User-mode Access Layer/ual_get_uvp_name_t

{ struct _ual_get_uvp_name_in { - ib_net64_t ca_guid; + ib_net64_t ca_guid; } in; struct _ual_get_uvp_name_out @@ -1632,7 +1632,7 @@ User-mode Access Layer/ual_get_uvp_name_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_local_mad_ioctl_t

[top][index]

@@ -1650,13 +1650,13 @@ User-mode Access Layer/ual_local_mad_ioctl_t

{ uint64_t h_ca; uint8_t port_num; - uint8_t mad_in[MAD_BLOCK_SIZE]; + uint8_t mad_in[MAD_BLOCK_SIZE]; } in; struct _ual_local_mad_ioctl_out { ib_api_status_t status; - uint8_t mad_out[MAD_BLOCK_SIZE]; + uint8_t mad_out[MAD_BLOCK_SIZE]; } out; @@ -1679,7 +1679,7 @@ User-mode Access Layer/ual_local_mad_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_mad_recv_ioctl_t

[top][index]

@@ -1697,8 +1697,8 @@ User-mode Access Layer/ual_mad_recv_ioctl_t

{ uint64_t h_mad; ib_mad_element_t* __ptr64 p_user_mad; - ib_mad_t* __ptr64 p_mad_buf; - ib_grh_t* __ptr64 p_grh; + ib_mad_t* __ptr64 p_mad_buf; + ib_grh_t* __ptr64 p_grh; } in; struct _ual_mad_recv_comp_ioctl_out @@ -1728,7 +1728,7 @@ User-mode Access Layer/ual_mad_recv_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_modify_av_ioctl_t

[top][index]

@@ -1744,14 +1744,14 @@ User-mode Access Layer/ual_modify_av_ioctl_t

{ struct _ual_modify_av_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_av; ib_av_attr_t attr; } in; struct _ual_modify_av_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; } out; @@ -1779,7 +1779,7 @@ User-mode Access Layer/ual_modify_av_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_modify_ca_ioctl_t

[top][index]

@@ -1821,7 +1821,7 @@ User-mode Access Layer/ual_modify_ca_ioctl_t

The mask of the attributes and counters to modify. in.port_attr_mod - List of port attribute information to modify. + List of port attribute information to modify. out.status Status of the operation @@ -1829,7 +1829,7 @@ User-mode Access Layer/ual_modify_ca_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_modify_cq_ioctl_t

[top][index]

@@ -1845,14 +1845,14 @@ User-mode Access Layer/ual_modify_cq_ioctl_t

{ struct _ual_modify_cq_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_cq; uint32_t size; } in; struct _ual_modify_cq_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; uint32_t size; @@ -1884,7 +1884,7 @@ User-mode Access Layer/ual_modify_cq_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_modify_qp_ioctl_t

[top][index]

@@ -1900,14 +1900,14 @@ User-mode Access Layer/ual_modify_qp_ioctl_t

{ struct _ual_modify_qp_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_qp; ib_qp_mod_t modify_attr; } in; struct _ual_modify_qp_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; //ib_qp_query_t query_attr; // Not returned by AL @@ -1940,7 +1940,7 @@ User-mode Access Layer/ual_modify_qp_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_open_ca_ioctl_t

[top][index]

@@ -1956,15 +1956,15 @@ User-mode Access Layer/ual_open_ca_ioctl_t

{ struct _ual_open_ca_ioctl_in { - ci_umv_buf_t umv_buf; - ib_net64_t guid; + ci_umv_buf_t umv_buf; + ib_net64_t guid; void* __ptr64 context; } in; struct _ual_open_ca_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; uint64_t h_ca; @@ -1998,7 +1998,7 @@ User-mode Access Layer/ual_open_ca_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_peek_cq_ioctl_t

[top][index]

@@ -2039,7 +2039,7 @@ User-mode Access Layer/ual_peek_cq_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_poll_cq_ioctl_t

[top][index]

@@ -2088,7 +2088,7 @@ User-mode Access Layer/ual_poll_cq_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_poll_pnp_ioctl_t

[top][index]

@@ -2128,7 +2128,7 @@ User-mode Access Layer/ual_poll_pnp_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_post_recv_ioctl_t

[top][index]

@@ -2182,7 +2182,7 @@ User-mode Access Layer/ual_post_recv_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_post_send_ioctl_t

[top][index]

@@ -2236,7 +2236,7 @@ User-mode Access Layer/ual_post_send_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_query_av_ioctl_t

[top][index]

@@ -2252,13 +2252,13 @@ User-mode Access Layer/ual_query_av_ioctl_t

{ struct _ual_query_av_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_av; } in; struct _ual_query_av_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; ib_av_attr_t attr; void* __ptr64 pd_context; @@ -2291,7 +2291,7 @@ User-mode Access Layer/ual_query_av_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_query_ca_ioctl_t

[top][index]

@@ -2307,7 +2307,7 @@ User-mode Access Layer/ual_query_ca_ioctl_t

{ struct _ual_query_ca_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_ca; uint32_t byte_cnt; ib_ca_attr_t* __ptr64 p_ca_attr; @@ -2315,7 +2315,7 @@ User-mode Access Layer/ual_query_ca_ioctl_t } in; struct _ual_query_ca_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; uint32_t byte_cnt; @@ -2357,7 +2357,7 @@ User-mode Access Layer/ual_query_ca_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_query_cq_ioctl_t

[top][index]

@@ -2373,13 +2373,13 @@ User-mode Access Layer/ual_query_cq_ioctl_t

{ struct _ual_query_cq_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_cq; } in; struct _ual_query_cq_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; uint32_t size; @@ -2408,7 +2408,7 @@ User-mode Access Layer/ual_query_cq_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_query_mr_ioctl_t

[top][index]

@@ -2449,7 +2449,7 @@ User-mode Access Layer/ual_query_mr_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_query_mw_ioctl_t

[top][index]

@@ -2465,13 +2465,13 @@ User-mode Access Layer/ual_query_mw_ioctl_t

{ struct _ual_query_mw_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_mw; } in; struct _ual_query_mw_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; void* __ptr64 pd_context; net32_t rkey; @@ -2505,7 +2505,7 @@ User-mode Access Layer/ual_query_mw_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_query_qp_ioctl_t

[top][index]

@@ -2521,13 +2521,13 @@ User-mode Access Layer/ual_query_qp_ioctl_t

{ struct _ual_query_qp_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_qp; } in; struct _ual_query_qp_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; ib_qp_attr_t attr; @@ -2556,7 +2556,7 @@ User-mode Access Layer/ual_query_qp_ioctl_t
-

[Structures] +

[Structures] User-mode Access Layer/ual_rearm_cq_ioctl_t

[top][index]

@@ -2597,7 +2597,7 @@ User-mode Access Layer/ual_rearm_cq_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_rearm_n_cq_ioctl_t

[top][index]

@@ -2638,7 +2638,7 @@ User-mode Access Layer/ual_rearm_n_cq_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_rearm_pnp_ioctl_in_t

[top][index]

@@ -2662,7 +2662,7 @@ User-mode Access Layer/ual_rearm_pnp_ioctl_in_t

NOTES

       This is an asynchronous IOCTL.
 
-       The output parameters are a ual_rearm_pnp_ioctl_out_t.
+       The output parameters are a ual_rearm_pnp_ioctl_out_t.
 

PARAMETERS

       pnp_hdl
@@ -2680,7 +2680,7 @@ User-mode Access Layer/ual_rearm_pnp_ioctl_in_t
 
 
-

[Structures] +

[Structures] User-mode Access Layer/ual_rearm_pnp_ioctl_out_t

[top][index]

@@ -2713,7 +2713,7 @@ User-mode Access Layer/ual_rearm_pnp_ioctl_out_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_reg_mad_pool_ioctl_t

[top][index]

@@ -2757,7 +2757,7 @@ User-mode Access Layer/ual_reg_mad_pool_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_reg_mad_svc_ioctl_t

[top][index]

@@ -2802,7 +2802,7 @@ User-mode Access Layer/ual_reg_mad_svc_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_reg_mem_ioctl_t

[top][index]

@@ -2855,7 +2855,7 @@ User-mode Access Layer/ual_reg_mem_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_reg_pnp_ioctl_in_t

[top][index]

@@ -2879,7 +2879,7 @@ User-mode Access Layer/ual_reg_pnp_ioctl_in_t

NOTES

       This is an asynchronous IOCTL.
 
-       The output parameters are a ual_rearm_pnp_ioctl_out_t.
+       The output parameters are a ual_rearm_pnp_ioctl_out_t.
 

PARAMETERS

       pnp_class
@@ -2894,7 +2894,7 @@ User-mode Access Layer/ual_reg_pnp_ioctl_in_t
 
 
-

[Structures] +

[Structures] User-mode Access Layer/ual_reg_shared_ioctl_t

[top][index]

@@ -2959,7 +2959,7 @@ User-mode Access Layer/ual_reg_shared_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_reg_shmid_ioctl_t

[top][index]

@@ -3026,7 +3026,7 @@ User-mode Access Layer/ual_reg_shmid_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_rereg_mem_ioctl_t

[top][index]

@@ -3084,7 +3084,7 @@ User-mode Access Layer/ual_rereg_mem_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_send_mad_ioctl_t

[top][index]

@@ -3141,7 +3141,7 @@ User-mode Access Layer/ual_send_mad_ioctl_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_send_sa_req_t

[top][index]

@@ -3202,7 +3202,7 @@ User-mode Access Layer/ual_send_sa_req_t


-

[Structures] +

[Structures] User-mode Access Layer/ual_spl_qp_ioctl_t

[top][index]

@@ -3218,16 +3218,16 @@ User-mode Access Layer/ual_spl_qp_ioctl_t

{ struct _ual_spl_qp_ioctl_in { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; uint64_t h_pd; - ib_net64_t port_guid; + ib_net64_t port_guid; ib_qp_create_t qp_create; void* __ptr64 context; } in; struct _ual_spl_qp_ioctl_out { - ci_umv_buf_t umv_buf; + ci_umv_buf_t umv_buf; ib_api_status_t status; uint64_t h_qp; diff --git a/trunk/docs/iba/ib_ci_h.html b/trunk/docs/iba/ib_ci_h.html index 8160cf8d..057d22a3 100644 --- a/trunk/docs/iba/ib_ci_h.html +++ b/trunk/docs/iba/ib_ci_h.html @@ -2,12 +2,12 @@ -./inc_doc/iba/ib_ci_h.html +./inc_docs/iba/ib_ci_h.html -Generated from ./inc/iba/ib_ci.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/iba/ib_ci.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

@@ -44,7 +44,7 @@ IB_API/Verbs
-

[Functions] +

[Functions] Verbs/ci_alloc_mlnx_fmr

[top][parent][index]

@@ -91,12 +91,12 @@ Verbs/ci_alloc_mlnx_fmr

This is a Mellanox specific extension to verbs.

SEE ALSO

-
       ci_dealloc_mlnx_fmr, ci_map_phys_mlnx_fmr, ci_unmap_mlnx_fmr
+
       ci_dealloc_mlnx_fmr, ci_map_phys_mlnx_fmr, ci_unmap_mlnx_fmr
 

-

[Functions] +

[Functions] Verbs/ci_allocate_pd

[top][parent][index]

@@ -109,7 +109,7 @@ Verbs/ci_allocate_pd

IN const ib_ca_handle_t h_ca, IN const ib_pd_type_t type, OUT ib_pd_handle_t *ph_pd, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine allocates a protection domain handle, which is later
@@ -119,7 +119,7 @@ Verbs/ci_allocate_pd
 

PARAMETERS

       h_ca
-               [in] Handle returned by ci_open_ca()
+               [in] Handle returned by ci_open_ca()
 
        type
                [in] Type of the protection domain.  CA vendors may use this
@@ -142,12 +142,12 @@ Verbs/ci_allocate_pd
                HCA handle is not valid
 

SEE ALSO

-
       ci_deallocate_pd
+
       ci_deallocate_pd
 

-

[Functions] +

[Functions] Verbs/ci_async_event_cb_t

[top][parent][index]

@@ -160,7 +160,7 @@ Verbs/ci_async_event_cb_t

SYNOPSIS

typedef void
 (*ci_async_event_cb_t)(
-        IN      const   ib_event_rec_t* const                   p_event_record );
+        IN      const   ib_event_rec_t* const                   p_event_record );
 

PARAMETERS

       p_event_record
@@ -175,7 +175,7 @@ Verbs/ci_async_event_cb_t
 
 
-

[Functions] +

[Functions] Verbs/ci_attach_mcast

[top][parent][index]

@@ -186,10 +186,10 @@ Verbs/ci_attach_mcast

typedef ib_api_status_t
 (*ci_attach_mcast) (
         IN              const   ib_qp_handle_t                          h_qp,
-        IN              const   ib_gid_t                                        *p_mcast_gid,
-        IN              const   ib_net16_t                                      mcast_lid,
+        IN              const   ib_gid_t                                        *p_mcast_gid,
+        IN              const   ib_net16_t                                      mcast_lid,
                 OUT                     ib_mcast_handle_t                       *ph_mcast,
-        IN      OUT                     ci_umv_buf_t                            *p_umv_buf OPTIONAL );
+        IN      OUT                     ci_umv_buf_t                            *p_umv_buf OPTIONAL );
 

DESCRIPTION

       This routine attaches the given qp_handle to a multicast gid as specified
@@ -229,12 +229,12 @@ Verbs/ci_attach_mcast
                One of the parameters was NULL.
 

SEE ALSO

-
       ci_create_qp, ci_detach_mcast
+
       ci_create_qp, ci_detach_mcast
 

-

[Functions] +

[Functions] Verbs/ci_bind_mw

[top][parent][index]

@@ -299,12 +299,12 @@ Verbs/ci_bind_mw

and returns an R_KEY in the unbound state.

SEE ALSO

-
       ci_create_mw
+
       ci_create_mw
 

-

[Functions] +

[Functions] Verbs/ci_close_ca

[top][parent][index]

@@ -319,11 +319,11 @@ Verbs/ci_close_ca

DESCRIPTION

       This routine is called when the client no longer wishes to use HCA
        resources obtained via this h_ca. All resources allocated as part
-       this handle during the ci_open_ca are destroyed.
+       this handle during the ci_open_ca are destroyed.
 

PARAMETERS

       h_ca
-               [in] CA handle returned via the ci_open_ca() call.
+               [in] CA handle returned via the ci_open_ca() call.
 

RETURN VALUE

       IB_SUCCESS
@@ -338,20 +338,20 @@ Verbs/ci_close_ca
 

NOTES

       This call cannot be called from any of the notification functions invoked
        by the Verbs driver. For e.g. the completion handler or the async error
-       callback provided during the ci_open_ca() call. The call will block until
+       callback provided during the ci_open_ca() call. The call will block until
        all references to this adapter object is closed which includes all the
        pending callbacks returning back to the verbs provider driver.
 
-       Resources allocated during the ci_open_ca() is deallocated. Other resource
+       Resources allocated during the ci_open_ca() is deallocated. Other resource
        cleanup are responsibility of the consumer .
 

SEE ALSO

-
       ci_open_ca
+
       ci_open_ca
 

-

[Functions] +

[Functions] Verbs/ci_completion_cb_t

[top][parent][index]

@@ -364,12 +364,12 @@ Verbs/ci_completion_cb_t

IN void *cq_context );

DESCRIPTION

-
       This function prototype indicates the parameter passed to ci_open_ca()
+
       This function prototype indicates the parameter passed to ci_open_ca()
        to receive completion callbacks.
 

PARAMETERS

       cq_context
-               [in] Completion queue context passed during the ci_create_cq
+               [in] Completion queue context passed during the ci_create_cq
 

RETURN VALUE

       None
@@ -377,15 +377,15 @@ Verbs/ci_completion_cb_t
 

NOTES

       The consumer only gets the cq_context and ca_context. It is the client
        responsibility to store the cq_handle in the context after the creation
-       time. So it can call ci_poll_cq() after the arrival of the notification.
+       time. So it can call ci_poll_cq() after the arrival of the notification.
 

SEE ALSO

-
       ci_open_ca, ci_create_cq
+
       ci_open_ca, ci_create_cq
 

-

[Functions] +

[Functions] Verbs/ci_create_av

[top][parent][index]

@@ -398,7 +398,7 @@ Verbs/ci_create_av

IN const ib_pd_handle_t h_pd, IN const ib_av_attr_t *p_av_attr, OUT ib_av_handle_t *ph_av, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine creates an address vector for use in unreliable datagram
@@ -434,12 +434,12 @@ Verbs/ci_create_av
        validation fails a processing error IB_WCS_LOCAL_OP_ERR.
 

SEE ALSO

-
       ci_allocate_pd
+
       ci_allocate_pd
 

-

[Functions] +

[Functions] Verbs/ci_create_cq

[top][parent][index]

@@ -453,7 +453,7 @@ Verbs/ci_create_cq

IN const void *cq_context, IN OUT uint32_t* const p_size, OUT ib_cq_handle_t *ph_cq, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       The consumer must specify the minimum number of entries in the CQ. The
@@ -489,7 +489,7 @@ Verbs/ci_create_cq
 

NOTES

       The consumer would need a way to retrieve the cq_handle associated with
-       context being returned, so it can perform ci_poll_cq() to retrieve
+       context being returned, so it can perform ci_poll_cq() to retrieve
        completion queue entries. The handle as such is not being passed, since
        there is no information in the handle that is visible to the consumer.
        Passing a context directly would help avoid any reverse lookup that the
@@ -497,12 +497,12 @@ Verbs/ci_create_cq
        data-structures needed to process this completion completely.
 

SEE ALSO

-
       ci_destroy_cq, ci_query_cq, ci_resize_cq
+
       ci_destroy_cq, ci_query_cq, ci_resize_cq
 

-

[Functions] +

[Functions] Verbs/ci_create_mw

[top][parent][index]

@@ -515,12 +515,12 @@ Verbs/ci_create_mw

IN const ib_pd_handle_t h_pd, OUT net32_t* const p_rkey, OUT ib_mw_handle_t *ph_mw, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine allocates a memory window. This window entry cannot be used
        for remote access unless this window is bound to a memory region
-       via the ci_bind_mw call.
+       via the ci_bind_mw call.
 

PARAMETERS

       h_pd
@@ -528,7 +528,7 @@ Verbs/ci_create_mw
        p_rkey
                [out] Remote access key that can be exchanged with a remote node to
                perform RDMA transactions on this memory window. This R_KEY is still not
-               bound to any memory regions, until a successful call to ci_bind_mw.
+               bound to any memory regions, until a successful call to ci_bind_mw.
                VPD is required to give this in the expected ordering on the wire. When
                rkey's are exchanged between remote nodes, no swapping of this data
                will be performed.
@@ -548,12 +548,12 @@ Verbs/ci_create_mw
                One of the pointers was not valid.
 

SEE ALSO

-
       ci_destroy_mw, ci_query_mw, ci_bind_mw
+
       ci_destroy_mw, ci_query_mw, ci_bind_mw
 

-

[Functions] +

[Functions] Verbs/ci_create_qp

[top][parent][index]

@@ -568,7 +568,7 @@ Verbs/ci_create_qp

IN const ib_qp_create_t *p_create_attr, OUT ib_qp_attr_t *p_qp_attr, OUT ib_qp_handle_t *ph_qp, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       A new queue pair is created on the specified HCA. The initial set of
@@ -617,12 +617,12 @@ Verbs/ci_create_qp
        qp_query_attr and qp_handle is undefined.
 

SEE ALSO

-
       ci_create_spl_qp, ci_query_qp, ci_modify_qp, ci_destroy_qp
+
       ci_create_spl_qp, ci_query_qp, ci_modify_qp, ci_destroy_qp
 

-

[Functions] +

[Functions] Verbs/ci_create_spl_qp

[top][parent][index]

@@ -692,12 +692,12 @@ Verbs/ci_create_spl_qp

a higher level of abstraction.

SEE ALSO

-
       ci_create_qp, ci_query_qp, ci_modify_qp, ci_destroy_qp
+
       ci_create_qp, ci_query_qp, ci_modify_qp, ci_destroy_qp
 

-

[Functions] +

[Functions] Verbs/ci_dealloc_mlnx_fmr

[top][parent][index]

@@ -733,12 +733,12 @@ Verbs/ci_dealloc_mlnx_fmr

       This is a Mellanox specific extension to verbs.
 

SEE ALSO

-
       ci_dealloc_mlnx_fmr, ci_map_phys_mlnx_fmr, ci_unmap_mlnx_fmr
+
       ci_dealloc_mlnx_fmr, ci_map_phys_mlnx_fmr, ci_unmap_mlnx_fmr
 

-

[Functions] +

[Functions] Verbs/ci_deallocate_pd

[top][parent][index]

@@ -751,13 +751,13 @@ Verbs/ci_deallocate_pd

IN ib_pd_handle_t h_pd );

DESCRIPTION

-
       This routine deallocates a pd that is allocated via the ci_allocate_pd()
+
       This routine deallocates a pd that is allocated via the ci_allocate_pd()
        call. The PD cannot be deallocated if it is still bound to a QP, any memory
        region, memory window or address vector.
 

PARAMETERS

       h_pd
-               [in] Handle allocated via the ci_allocate_pd()
+               [in] Handle allocated via the ci_allocate_pd()
 

RETURN VALUE

       IB_SUCCESS
@@ -768,12 +768,12 @@ Verbs/ci_deallocate_pd
                PD is probably still bound to some resource
 

SEE ALSO

-
       ci_allocate_pd
+
       ci_allocate_pd
 

-

[Functions] +

[Functions] Verbs/ci_deregister_mr

[top][parent][index]

@@ -808,12 +808,12 @@ Verbs/ci_deregister_mr

NOTES

SEE ALSO

-
       ci_register_mr, ci_register_pmr, ci_register_smr
+
       ci_register_mr, ci_register_pmr, ci_register_smr
 

-

[Functions] +

[Functions] Verbs/ci_destroy_av

[top][parent][index]

@@ -840,12 +840,12 @@ Verbs/ci_destroy_av

The address vector handle was invalid

SEE ALSO

-
       ci_create_av
+
       ci_create_av
 

-

[Functions] +

[Functions] Verbs/ci_destroy_cq

[top][parent][index]

@@ -880,19 +880,19 @@ Verbs/ci_destroy_cq

one of the parameters was NULL.

SEE ALSO

-
       ci_create_cq
+
       ci_create_cq
 

NOTES

       This call cannot be called from any of the notification functions invoked
        by the Verbs driver. For e.g. the completion handler or the async error
-       callback provided during the ci_open_ca() call. The call will block until
+       callback provided during the ci_open_ca() call. The call will block until
        all references to this adapter object is closed which includes all the
        pending callbacks returning back to the verbs provider driver.
 

-

[Functions] +

[Functions] Verbs/ci_destroy_mw

[top][parent][index]

@@ -905,7 +905,7 @@ Verbs/ci_destroy_mw

IN const ib_mw_handle_t h_mw );

DESCRIPTION

-
       This routine deallocates a window entry created via a ci_create_mw.
+
       This routine deallocates a window entry created via a ci_create_mw.
        Once this operation is complete, the channel interface guarantees that
        no future remote accesses will be permitted to this window entry.
 
@@ -925,12 +925,12 @@ Verbs/ci_destroy_mw the same R_KEY should fail with protection violation.

SEE ALSO

-
       ci_create_mw
+
       ci_create_mw
 

-

[Functions] +

[Functions] Verbs/ci_destroy_qp

[top][parent][index]

@@ -971,22 +971,22 @@ Verbs/ci_destroy_qp

NOTES

       This call cannot be called from any of the notification functions invoked
        by the Verbs driver. For e.g. the completion handler or the async error
-       callback provided during the ci_open_ca() call. The call will block until
+       callback provided during the ci_open_ca() call. The call will block until
        all references to this adapter object is closed which includes all the
        pending callbacks returning back to the verbs provider driver.
 
        If the CQ associated with this QP is still not destroyed, the completions
-       on behalf of this QP can still be pulled via the ci_poll_cq() call. Any
+       on behalf of this QP can still be pulled via the ci_poll_cq() call. Any
        resources allocated by the Channel Interface must be deallocated as part
        of this call.
 

SEE ALSO

-
       ci_create_qp, ci_create_spl_qp
+
       ci_create_qp, ci_create_spl_qp
 

-

[Functions] +

[Functions] Verbs/ci_detach_mcast

[top][parent][index]

@@ -1016,12 +1016,12 @@ Verbs/ci_detach_mcast

One of the parameters was NULL.

SEE ALSO

-
       ci_attach_mcast
+
       ci_attach_mcast
 

-

[Functions] +

[Functions] Verbs/ci_enable_cq_notify

[top][parent][index]

@@ -1058,32 +1058,32 @@ Verbs/ci_enable_cq_notify

       The consumer cannot call a request for notification without emptying
        entries from the CQ. i.e if a consumer registers for a notification
        request in the completion callback before pulling entries from the
-       CQ via ci_poll_cq, the notification is not generated for completions
+       CQ via ci_poll_cq, the notification is not generated for completions
        already in the CQ. For e.g. in the example below, if there are no calls
-   to ci_poll_cq()     after the ci_enable_cq_notify(). For any CQ entries added
+   to ci_poll_cq()     after the ci_enable_cq_notify(). For any CQ entries added
        before calling this ci_enable_cq_notify() call, the consumer does not
        get a completion notification callback. In order to comply with the verb
-       spec, consumer is supposed to perform a ci_poll_cq() after the
+       spec, consumer is supposed to perform a ci_poll_cq() after the
        ci_enable_cq_notify() is made to retrive any entries that might have
        been added to the CQ before the CI registers the notification enable.
 
-                       while ((ret_val = ci_poll_cq(cq_handle, &free_list, &done_list)
+                       while ((ret_val = ci_poll_cq(cq_handle, &free_list, &done_list)
                                == FSUCCESS))
                        {
                                process entries;
                        }
                        if (ret_val == IB_NOT_FOUND)
                                ci_enable_cq_notify(cq_handle);
-                       // Need to perform a ci_poll_cq()
+                       // Need to perform a ci_poll_cq()
            // after the enable.
 

SEE ALSO

-
       ci_create_cq, ci_peek_cq, ci_poll_cq, ci_enable_ncomp_cq_notify
+
       ci_create_cq, ci_peek_cq, ci_poll_cq, ci_enable_ncomp_cq_notify
 

-

[Functions] +

[Functions] Verbs/ci_enable_ncomp_cq_notify

[top][parent][index]

@@ -1129,12 +1129,12 @@ Verbs/ci_enable_ncomp_cq_notify

vendor.

SEE ALSO

-
       ci_create_cq, ci_peek_cq, ci_poll_cq, ci_enable_cq_notify
+
       ci_create_cq, ci_peek_cq, ci_poll_cq, ci_enable_cq_notify
 

-

[Structures] +

[Structures] Verbs/ci_interface_t

[top][parent][index]

@@ -1174,108 +1174,108 @@ Verbs/ci_interface_t

/* * HCA Access Verbs */ - ci_open_ca open_ca; + ci_open_ca open_ca; ci_um_open_ca_t um_open_ca; - ci_query_ca query_ca; - ci_modify_ca modify_ca; - ci_close_ca close_ca; - ci_um_close_ca_t um_close_ca; + ci_query_ca query_ca; + ci_modify_ca modify_ca; + ci_close_ca close_ca; + ci_um_close_ca_t um_close_ca; - ci_vendor_call vendor_call; + ci_vendor_call vendor_call; /* * Protection Domain */ - ci_allocate_pd allocate_pd; - ci_deallocate_pd deallocate_pd; + ci_allocate_pd allocate_pd; + ci_deallocate_pd deallocate_pd; /* * Address Vector Management Verbs */ - ci_create_av create_av; - ci_query_av query_av; - ci_modify_av modify_av; - ci_destroy_av destroy_av; + ci_create_av create_av; + ci_query_av query_av; + ci_modify_av modify_av; + ci_destroy_av destroy_av; /* * QP Management Verbs */ - ci_create_qp create_qp; - ci_create_spl_qp create_spl_qp; - ci_modify_qp modify_qp; - ci_query_qp query_qp; - ci_destroy_qp destroy_qp; + ci_create_qp create_qp; + ci_create_spl_qp create_spl_qp; + ci_modify_qp modify_qp; + ci_query_qp query_qp; + ci_destroy_qp destroy_qp; /* * Completion Queue Management Verbs */ - ci_create_cq create_cq; - ci_resize_cq resize_cq; - ci_query_cq query_cq; - ci_destroy_cq destroy_cq; + ci_create_cq create_cq; + ci_resize_cq resize_cq; + ci_query_cq query_cq; + ci_destroy_cq destroy_cq; /* * Memory Management Verbs */ - ci_register_mr register_mr; - ci_register_pmr register_pmr; - ci_query_mr query_mr; - ci_modify_mr modify_mr; - ci_modify_pmr modify_pmr; - ci_register_smr register_smr; - ci_deregister_mr deregister_mr; + ci_register_mr register_mr; + ci_register_pmr register_pmr; + ci_query_mr query_mr; + ci_modify_mr modify_mr; + ci_modify_pmr modify_pmr; + ci_register_smr register_smr; + ci_deregister_mr deregister_mr; /* * Mellanox Fast Memory Management Verbs */ - ci_alloc_mlnx_fmr alloc_mlnx_fmr; - ci_map_phys_mlnx_fmr map_phys_mlnx_fmr; - ci_unmap_mlnx_fmr unmap_mlnx_fmr; - ci_dealloc_mlnx_fmr dealloc_mlnx_fmr; + ci_alloc_mlnx_fmr alloc_mlnx_fmr; + ci_map_phys_mlnx_fmr map_phys_mlnx_fmr; + ci_unmap_mlnx_fmr unmap_mlnx_fmr; + ci_dealloc_mlnx_fmr dealloc_mlnx_fmr; /* * Memory Window Verbs */ - ci_create_mw create_mw; - ci_query_mw query_mw; - ci_bind_mw bind_mw; - ci_destroy_mw destroy_mw; + ci_create_mw create_mw; + ci_query_mw query_mw; + ci_bind_mw bind_mw; + ci_destroy_mw destroy_mw; /* * Work Request Processing Verbs */ - ci_post_send post_send; - ci_post_recv post_recv; + ci_post_send post_send; + ci_post_recv post_recv; /* * Completion Processing and * Completion Notification Request Verbs. */ - ci_peek_cq peek_cq; /* Optional */ - ci_poll_cq poll_cq; - ci_enable_cq_notify enable_cq_notify; - ci_enable_ncomp_cq_notify enable_ncomp_cq_notify; /* Optional */ + ci_peek_cq peek_cq; /* Optional */ + ci_poll_cq poll_cq; + ci_enable_cq_notify enable_cq_notify; + ci_enable_ncomp_cq_notify enable_ncomp_cq_notify; /* Optional */ /* * Multicast Support Verbs */ - ci_attach_mcast attach_mcast; - ci_detach_mcast detach_mcast; + ci_attach_mcast attach_mcast; + ci_detach_mcast detach_mcast; /* * Local MAD support, for HCA's that do not support * Agents in the HW. */ - ci_local_mad local_mad; + ci_local_mad local_mad; } ci_interface_t;

-

[Functions] +

[Functions] Verbs/ci_local_mad

[top][parent][index]

@@ -1287,8 +1287,9 @@ Verbs/ci_local_mad

(*ci_local_mad) ( IN const ib_ca_handle_t h_ca, IN const uint8_t port_num, - IN const ib_mad_t *p_mad_in, - OUT ib_mad_t *p_mad_out ); + IN const ib_av_attr_t *p_src_av_attr, + IN const ib_mad_t *p_mad_in, + OUT ib_mad_t *p_mad_out );

DESCRIPTION

       This routine is OPTIONAL for the channel interface. This is required
@@ -1337,17 +1338,17 @@ Verbs/ci_local_mad
        instead of making a private call to the adapter.
 

SEE ALSO

-
       ci_query_ca, ci_ca_attr_t
+
       ci_query_ca, ci_ca_attr_t
 

-

[Functions] +

[Functions] Verbs/ci_map_phys_mlnx_fmr

[top][parent][index]

NAME

-
       ci_map_phys_mlnx_fmr -- Map a Mellanox fast memory region with a
+
       ci_map_phys_mlnx_fmr -- Map a Mellanox fast memory region with a
        given page list.
 

SYNOPSIS

@@ -1400,12 +1401,12 @@ Verbs/ci_map_phys_mlnx_fmr

This is a Mellanox specific extension to verbs.

SEE ALSO

-
       ci_dealloc_mlnx_fmr, ci_alloc_mlnx_fmr, ci_unmap_mlnx_fmr
+
       ci_dealloc_mlnx_fmr, ci_alloc_mlnx_fmr, ci_unmap_mlnx_fmr
 

-

[Functions] +

[Functions] Verbs/ci_modify_av

[top][parent][index]

@@ -1417,7 +1418,7 @@ Verbs/ci_modify_av

(*ci_modify_av) ( IN const ib_av_handle_t h_av, IN const ib_av_attr_t *p_av_attr, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine allows a consumer to modify the address information
@@ -1448,12 +1449,12 @@ Verbs/ci_modify_av
        a processing error IB_WCS_LOCAL_OP_ERR.
 

SEE ALSO

-
       ci_create_av, ci_query_av
+
       ci_create_av, ci_query_av
 

-

[Functions] +

[Functions] Verbs/ci_modify_ca

[top][parent][index]

@@ -1476,7 +1477,7 @@ Verbs/ci_modify_ca

PARAMETERS

       h_ca
-               [in] Handle returned by previous call to ci_open_ca()
+               [in] Handle returned by previous call to ci_open_ca()
        port_num
                [in] Port number, which needs to be modified.
        ca_mod
@@ -1507,12 +1508,12 @@ Verbs/ci_modify_ca
  values, but the agent capability is really a QP1 functionality.
 

SEE ALSO

-
       ci_open_ca, ci_query_ca, ci_close_ca
+
       ci_open_ca, ci_query_ca, ci_close_ca
 

-

[Functions] +

[Functions] Verbs/ci_modify_mr

[top][parent][index]

@@ -1532,9 +1533,9 @@ Verbs/ci_modify_mr

DESCRIPTION

       This routine modifies attributes of the specified memory region
-       irrespective of whether the handle was obtained via ci_register_mr
-       or ci_register_pmr. This verb conceptually performs a de-registration
-       followed by a ci_register_mr.
+       irrespective of whether the handle was obtained via ci_register_mr
+       or ci_register_pmr. This verb conceptually performs a de-registration
+       followed by a ci_register_mr.
 

PARAMETERS

       h_mr
@@ -1586,12 +1587,12 @@ Verbs/ci_modify_mr
        TBD: How to handle shared memory region being passed to modify_mem?
 

SEE ALSO

-
       ci_register_mr, ci_register_pmr, ci_register_smr
+
       ci_register_mr, ci_register_pmr, ci_register_smr
 

-

[Functions] +

[Functions] Verbs/ci_modify_pmr

[top][parent][index]

@@ -1612,9 +1613,9 @@ Verbs/ci_modify_pmr

DESCRIPTION

       This routine modifies attributes of the specified memory region
-       irrespective of whether the handle was obtained via ci_register_mr
-       or ci_register_pmr. This verb conceptually performs a de-registration
-       followed by a ci_register_pmr.
+       irrespective of whether the handle was obtained via ci_register_mr
+       or ci_register_pmr. This verb conceptually performs a de-registration
+       followed by a ci_register_pmr.
 

PARAMETERS

       h_mr
@@ -1668,12 +1669,12 @@ Verbs/ci_modify_pmr
        write access to be enabled.
 

SEE ALSO

-
       ci_register_mr, ci_register_pmr, ci_register_smr
+
       ci_register_mr, ci_register_pmr, ci_register_smr
 

-

[Functions] +

[Functions] Verbs/ci_modify_qp

[top][parent][index]

@@ -1686,7 +1687,7 @@ Verbs/ci_modify_qp

IN const ib_qp_handle_t h_qp, IN const ib_qp_mod_t *p_modify_attr, OUT ib_qp_attr_t *p_qp_attr OPTIONAL, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine is used to modify the qp states or other attributes of the
@@ -1728,12 +1729,12 @@ Verbs/ci_modify_qp
 
       Refer to Table 79 in chapter 11, Volume 1 of the InfiniBand Specifications.
 

SEE ALSO

-
       ci_create_qp, ci_create_spl_qp, ci_query_qp
+
       ci_create_qp, ci_create_spl_qp, ci_query_qp
 

-

[Functions] +

[Functions] Verbs/ci_open_ca

[top][parent][index]

@@ -1743,9 +1744,9 @@ Verbs/ci_open_ca

SYNOPSIS

typedef ib_api_status_t
 (*ci_open_ca) (
-        IN              const   ib_net64_t                                      ca_guid,
-        IN              const   ci_completion_cb_t                      pfn_completion_cb,
-        IN              const   ci_async_event_cb_t                     pfn_async_event_cb,
+        IN              const   ib_net64_t                                      ca_guid,
+        IN              const   ci_completion_cb_t                      pfn_completion_cb,
+        IN              const   ci_async_event_cb_t                     pfn_async_event_cb,
         IN              const   void* const                                     ca_context,
                 OUT                     ib_ca_handle_t                          *ph_ca );
 
@@ -1788,12 +1789,12 @@ Verbs/ci_open_ca ca_guid passed is not valid

SEE ALSO

-
       ci_query_ca, ci_modify_ca, ci_close_ca
+
       ci_query_ca, ci_modify_ca, ci_close_ca
 

-

[Functions] +

[Functions] Verbs/ci_peek_cq

[top][parent][index]

@@ -1832,12 +1833,12 @@ Verbs/ci_peek_cq

is optional by a channel adapter vendor.

SEE ALSO

-
       ci_create_cq, ci_poll_cq, ci_enable_cq_notify, ci_enable_ncomp_cq_notify
+
       ci_create_cq, ci_poll_cq, ci_enable_cq_notify, ci_enable_ncomp_cq_notify
 

-

[Functions] +

[Functions] Verbs/ci_poll_cq

[top][parent][index]

@@ -1879,12 +1880,12 @@ Verbs/ci_poll_cq

There were no completion entries found in the specified CQ.

SEE ALSO

-
       ci_create_cq, ci_post_send, ci_post_recv, ci_bind_mw
+
       ci_create_cq, ci_post_send, ci_post_recv, ci_bind_mw
 

-

[Functions] +

[Functions] Verbs/ci_post_recv

[top][parent][index]

@@ -1932,12 +1933,12 @@ Verbs/ci_post_recv

(TBD: there may be an errata that allows posting in init state)

SEE ALSO

-
       ci_post_send, ci_poll_cq.
+
       ci_post_send, ci_poll_cq.
 

-

[Functions] +

[Functions] Verbs/ci_post_send

[top][parent][index]

@@ -2000,12 +2001,12 @@ Verbs/ci_post_send

acceptable for the work request for different QP service types.

SEE ALSO

-
       ci_post_recv, ci_poll_cq
+
       ci_post_recv, ci_poll_cq
 

-

[Functions] +

[Functions] Verbs/ci_query_av

[top][parent][index]

@@ -2018,7 +2019,7 @@ Verbs/ci_query_av

IN const ib_av_handle_t h_av, OUT ib_av_attr_t *p_av_attr, OUT ib_pd_handle_t *ph_pd, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine returns the address vector and pd_handle associated with the
@@ -2045,12 +2046,12 @@ Verbs/ci_query_av
                Invalid port number passed in the Address Vector.
 

SEE ALSO

-
       ci_create_av, ci_modify_av
+
       ci_create_av, ci_modify_av
 

-

[Functions] +

[Functions] Verbs/ci_query_ca

[top][parent][index]

@@ -2063,7 +2064,7 @@ Verbs/ci_query_ca

IN const ib_ca_handle_t h_ca, OUT ib_ca_attr_t *p_ca_attr OPTIONAL, IN OUT uint32_t *p_size, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine retrieves vital information about this hca. It returns
@@ -2073,7 +2074,7 @@ Verbs/ci_query_ca
 

PARAMETERS

       h_ca
-               [in] Handle returned by an earlier call to ci_open_ca()
+               [in] Handle returned by an earlier call to ci_open_ca()
        p_ca_attr
                [out] CA attribute of this Host Channel adapter
        p_size
@@ -2104,12 +2105,12 @@ Verbs/ci_query_ca
        if the size is not sufficient.
 

SEE ALSO

-
       ci_open_ca, ci_modify_ca
+
       ci_open_ca, ci_modify_ca
 

-

[Functions] +

[Functions] Verbs/ci_query_cq

[top][parent][index]

@@ -2121,7 +2122,7 @@ Verbs/ci_query_cq

(*ci_query_cq) ( IN const ib_cq_handle_t h_cq, OUT uint32_t *p_size, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine returns the maximum number of entries this completion
@@ -2144,12 +2145,12 @@ Verbs/ci_query_cq
                one of the parameters was NULL.
 

SEE ALSO

-
       ci_create_cq, ci_resize_cq
+
       ci_create_cq, ci_resize_cq
 

-

[Functions] +

[Functions] Verbs/ci_query_mr

[top][parent][index]

@@ -2165,7 +2166,7 @@ Verbs/ci_query_mr

DESCRIPTION

       This routine retrieves the memory region attributed of a
        registered memory region. The memory handle could have been
-       obtained via ci_register_mr or ci_register_pmr.
+       obtained via ci_register_mr or ci_register_pmr.
 

PARAMETERS

       h_mr
@@ -2189,12 +2190,12 @@ Verbs/ci_query_mr
        down to kernel to protect from rogue applications.
 

SEE ALSO

-
       ci_register_mr, ci_register_pmr
+
       ci_register_mr, ci_register_pmr
 

-

[Functions] +

[Functions] Verbs/ci_query_mw

[top][parent][index]

@@ -2207,7 +2208,7 @@ Verbs/ci_query_mw

IN const ib_mw_handle_t h_mw, OUT ib_pd_handle_t *ph_pd, OUT net32_t* const p_rkey, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine retrieves the current R_KEY and protection domain
@@ -2235,12 +2236,12 @@ Verbs/ci_query_mw
                One of the pointers was not valid.
 

SEE ALSO

-
       ci_create_mw, ci_bind_mw
+
       ci_create_mw, ci_bind_mw
 

-

[Functions] +

[Functions] Verbs/ci_query_qp

[top][parent][index]

@@ -2252,7 +2253,7 @@ Verbs/ci_query_qp

(*ci_query_qp) ( IN const ib_qp_handle_t h_qp, OUT ib_qp_attr_t* const p_qp_attr, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine queries the current attributes for the QP
@@ -2278,12 +2279,12 @@ Verbs/ci_query_qp
                Parameter p_qp_attr is not valid.
 

SEE ALSO

-
       ci_create_qp
+
       ci_create_qp
 

-

[Functions] +

[Functions] Verbs/ci_register_mr

[top][parent][index]

@@ -2346,13 +2347,13 @@ Verbs/ci_register_mr

and unpredictable behavior by the operating environment.

SEE ALSO

-
       ci_deregister_mr, ci_query_mr, ci_register_pmr, ci_modify_mr,
-       ci_register_smr
+
       ci_deregister_mr, ci_query_mr, ci_register_pmr, ci_modify_mr,
+       ci_register_smr
 

-

[Functions] +

[Functions] Verbs/ci_register_pmr

[top][parent][index]

@@ -2425,13 +2426,13 @@ Verbs/ci_register_pmr

meaningful to the adapter to which this registration is targeted.

SEE ALSO

-
       ci_deregister_mr, ci_query_mr, ci_register_mr, ci_modify_mr,
-       ci_register_smr
+
       ci_deregister_mr, ci_query_mr, ci_register_mr, ci_modify_mr,
+       ci_register_smr
 

-

[Functions] +

[Functions] Verbs/ci_register_smr

[top][parent][index]

@@ -2493,17 +2494,17 @@ Verbs/ci_register_smr

Invalid access rights passed in mr_access.

NOTES

-
       ISSUE: how to deal with ci_deregister_mr, ci_modify_mr, ci_modify_pmr
+
       ISSUE: how to deal with ci_deregister_mr, ci_modify_mr, ci_modify_pmr
        should we treat them as memory windows and fail those if a shared region
        was registered?
 

SEE ALSO

-
       ci_register_mr, ci_register_pmr, ci_modify_mr, ci_modify_pmr
+
       ci_register_mr, ci_register_pmr, ci_modify_mr, ci_modify_pmr
 

-

[Functions] +

[Functions] Verbs/ci_resize_cq

[top][parent][index]

@@ -2515,7 +2516,7 @@ Verbs/ci_resize_cq

(*ci_resize_cq) ( IN const ib_cq_handle_t h_cq, IN OUT uint32_t* const p_size, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

DESCRIPTION

       This routine allows the caller to modify the maximum number of entries
@@ -2558,12 +2559,12 @@ Verbs/ci_resize_cq
        size returned in p_size.
 

SEE ALSO

-
       ci_create_cq
+
       ci_create_cq
 

-

[Functions] +

[Functions] Verbs/ci_um_close_ca_t

[top][parent][index]

@@ -2579,13 +2580,13 @@ Verbs/ci_um_close_ca_t

DESCRIPTION

       This routine is called when the client no longer wishes to use HCA
        resources obtained via this h_ca. All resources allocated as part
-       this handle during the ci_um_open_ca are destroyed.
+       this handle during the ci_um_open_ca are destroyed.
 

PARAMETERS

       h_ca
-               [in] CA handle returned via the ci_open_ca() call.
+               [in] CA handle returned via the ci_open_ca() call.
        h_um_ca
-               [in] CA handle returned via the ci_um_open_ca() call.
+               [in] CA handle returned via the ci_um_open_ca() call.
 

RETURN VALUE

       This funtion does not return a value.
@@ -2594,15 +2595,15 @@ Verbs/ci_um_close_ca_t
 
       This call is invoked from the context of a UM application when such an
        appliation closes the HCA in user-mode.
 
-       Resources allocated during the ci_um_open_ca() are deallocated.
+       Resources allocated during the ci_um_open_ca() are deallocated.
 

SEE ALSO

-
       ci_um_open_ca
+
       ci_um_open_ca
 

-

[Functions] +

[Functions] Verbs/ci_um_open_ca

[top][parent][index]

@@ -2613,7 +2614,7 @@ Verbs/ci_um_open_ca

typedef ib_api_status_t
 (*ci_um_open_ca_t) (
         IN              const   ib_ca_handle_t                          h_ca,
-        IN      OUT                     ci_umv_buf_t* const                     p_umv_buf,
+        IN      OUT                     ci_umv_buf_t* const                     p_umv_buf,
                 OUT                     ib_ca_handle_t* const           ph_um_ca );
 

DESCRIPTION

@@ -2622,7 +2623,7 @@ Verbs/ci_um_open_ca

PARAMETERS

       h_ca
-               [in] Handle returned by an earlier call to ci_open_ca()
+               [in] Handle returned by an earlier call to ci_open_ca()
        p_umv_buf
                [in/out] Vendor specific parameter to support user mode IO.
        ph_um_ca
@@ -2641,12 +2642,12 @@ Verbs/ci_um_open_ca
                The p_umv_buf parameters are insufficient to complete the request.
 

SEE ALSO

-
       ci_query_ca, ci_modify_ca, ci_close_ca
+
       ci_query_ca, ci_modify_ca, ci_close_ca
 

-

[Structures] +

[Structures] Verbs/ci_umv_buf_t

[top][parent][index]

@@ -2711,7 +2712,7 @@ Verbs/ci_umv_buf_t


-

[Functions] +

[Functions] Verbs/ci_unmap_mlnx_fmr

[top][parent][index]

@@ -2749,12 +2750,12 @@ Verbs/ci_unmap_mlnx_fmr

This is a Mellanox specific extension to verbs.

SEE ALSO

-
       ci_dealloc_mlnx_fmr, ci_alloc_mlnx_fmr, ci_map_phy_mlnx_fmr
+
       ci_dealloc_mlnx_fmr, ci_alloc_mlnx_fmr, ci_map_phy_mlnx_fmr
 

-

[Functions] +

[Functions] Verbs/ci_vendor_call

[top][parent][index]

@@ -2771,7 +2772,7 @@ Verbs/ci_vendor_call

IN const void* __ptr64* const handle_array OPTIONAL, IN uint32_t num_handles, IN ib_ci_op_t* const p_ci_op, - IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL ); + IN OUT ci_umv_buf_t *p_umv_buf OPTIONAL );

PARAMETERS

       h_ca
@@ -2829,14 +2830,14 @@ Verbs/ci_vendor_call
        access layer and the verbs provider driver.
 

SEE ALSO

-
       ci_open_ca, ci_allocate_pd, ci_create_av, ci_create_cq,
-       ci_create_qp, ci_register_mr, ci_register_pmr,
-       ci_register_smr, ci_create_mw, ib_ci_op_t
+
       ci_open_ca, ci_allocate_pd, ci_create_av, ci_create_cq,
+       ci_create_qp, ci_register_mr, ci_register_pmr,
+       ci_register_smr, ci_create_mw, ib_ci_op_t
 

-

[Functions] +

[Functions] Verbs/ib_deregister_ca

[top][parent][index]

@@ -2851,7 +2852,7 @@ Verbs/ib_deregister_ca

DESCRIPTION

       This routine is called by the HCA driver when this HCA would no longer be
        available for services. The access layer is expected to return all resources
-       back to the HCA driver, and perform a ci_close_ca on this interface.
+       back to the HCA driver, and perform a ci_close_ca on this interface.
 

PARAMETERS

       ca_guid
@@ -2871,12 +2872,12 @@ Verbs/ib_deregister_ca
 
       Kernel Mode only
 

SEE ALSO

-
       ib_register_ca, ci_interface_t
+
       ib_register_ca, ci_interface_t
 

-

[Functions] +

[Functions] Verbs/ib_register_ca

[top][parent][index]

@@ -2886,7 +2887,7 @@ Verbs/ib_register_ca

SYNOPSIS

AL_EXPORT ib_api_status_t
 ib_register_ca (
-        IN              const   ci_interface_t                          *p_ci );
+        IN              const   ci_interface_t                          *p_ci );
 

DESCRIPTION

       This routine is called by a HCA kernel mode driver to inform the
@@ -2898,7 +2899,7 @@ Verbs/ib_register_ca
 

PARAMETERS

       p_ci
-               [in] Pointer to the ci_interface_t structure that has the function
+               [in] Pointer to the ci_interface_t structure that has the function
                vector to support verbs functionality.
 

RETURN VALUE

@@ -2918,7 +2919,7 @@ Verbs/ib_register_ca
       Kernel Mode only
 

SEE ALSO

-
       ib_deregister_ca, ci_interface_t
+
       ib_deregister_ca, ci_interface_t
 
diff --git a/trunk/docs/iba/ib_types_h.html b/trunk/docs/iba/ib_types_h.html index 4e5880bc..06131339 100644 --- a/trunk/docs/iba/ib_types_h.html +++ b/trunk/docs/iba/ib_types_h.html @@ -2,12 +2,12 @@ -./inc_doc/iba/ib_types_h.html +./inc_docs/iba/ib_types_h.html -Generated from ./inc/iba/ib_types.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:30 +Generated from ./inc/iba/ib_types.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

@@ -42,7 +42,7 @@ IBA Base/Type Definitions

[Definitions] Access Layer/ib_access_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_access_t
 
@@ -69,7 +69,7 @@ Access Layer/ib_access_t

[Definitions] Access Layer/ib_api_status_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_api_status_t
 
@@ -145,7 +145,7 @@ Access Layer/ib_api_status_t

[Definitions] Access Layer/ib_apm_state_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_apm_state_t
 
@@ -167,7 +167,7 @@ Access Layer/ib_apm_state_t

[Definitions] Access Layer/ib_apr_status_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_apr_status_t
 
@@ -202,7 +202,7 @@ Access Layer/ib_apr_status_t

[Definitions] Access Layer/ib_atomic_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_atomic_t
 
@@ -235,7 +235,7 @@ Access Layer/ib_atomic_t

[Structures] Access Layer/ib_av_attr_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_av_attr_t
 
@@ -248,10 +248,10 @@ Access Layer/ib_av_attr_t uint8_t port_num; uint8_t sl; - ib_net16_t dlid; + ib_net16_t dlid; boolean_t grh_valid; - ib_grh_t grh; + ib_grh_t grh; uint8_t static_rate; uint8_t path_bits; @@ -267,7 +267,7 @@ Access Layer/ib_av_attr_t } ib_av_attr_t;

SEE ALSO

-
       ib_gid_t
+
       ib_gid_t
 

@@ -275,7 +275,7 @@ Access Layer/ib_av_attr_t

[Structures] Access Layer/ib_bind_wr_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_bind_wr_t
 
@@ -326,7 +326,7 @@ Access Layer/ib_bind_wr_t

[Structures] Access Layer/ib_ca_attr_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_ca_attr_t
 
@@ -336,7 +336,7 @@ Access Layer/ib_ca_attr_t

SYNOPSIS

typedef struct _ib_ca_attr
 {
-        ib_net64_t                              ca_guid;
+        ib_net64_t                              ca_guid;
 
         uint32_t                                vend_id;
         uint16_t                                dev_id;
@@ -405,7 +405,7 @@ Access Layer/ib_ca_attr_t
         boolean_t                               system_image_guid_support;
         boolean_t                               hw_agents;
 
-        ib_net64_t                              system_image_guid;
+        ib_net64_t                              system_image_guid;
 
         uint32_t                                num_page_sizes;
         uint8_t                                 num_ports;
@@ -582,7 +582,7 @@ Access Layer/ib_ca_attr_t
 

[Definitions] Access Layer/ib_ca_mod_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_ca_mod_t -- Modify port attributes and error counters
 
@@ -615,6 +615,7 @@ Access Layer/ib_ca_mod_t #define IB_CA_MOD_INIT_TYPE_VALUE 0x00200000 #define IB_CA_MOD_SYSTEM_IMAGE_GUID 0x00400000 #define IB_CA_MOD_IS_CLIENT_REREGISTER_SUPPORTED 0x00800000 +#define IB_CA_MOD_RESERVED_MASK 0xFF000000

VALUES

       IB_CA_MOD_IS_CM_SUPPORTED
@@ -696,6 +697,10 @@ Access Layer/ib_ca_mod_t
 
        IB_CA_MOD_IS_CLIENT_REREGISTER_SUPPORTED
                Used to modify the system image GUID for the port.
+
+       IB_CA_MOD_RESERVED_MASK
+               Mask of all the reserved bits.  If any of these bits are set
+               ib_modify_ca will return IB_INVALID_PARAMETER.
 

@@ -703,7 +708,7 @@ Access Layer/ib_ca_mod_t

[Structures] Access Layer/ib_ci_op_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_ci_op_t
 
@@ -761,7 +766,7 @@ Access Layer/ib_ci_op_t

[Definitions] Access Layer/ib_cm_cap_mask_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_cm_cap_mask_t
 
@@ -769,14 +774,14 @@ Access Layer/ib_cm_cap_mask_t
       Capability mask values in ClassPortInfo.
 

SYNOPSIS

-
#define IB_CM_RELIABLE_CONN_CAPABLE                     CL_HTON16(9)
-#define IB_CM_RELIABLE_DGRM_CAPABLE                     CL_HTON16(10)
-#define IB_CM_RDGRM_CAPABLE                                     CL_HTON16(11)
-#define IB_CM_UNRELIABLE_CONN_CAPABLE           CL_HTON16(12)
-#define IB_CM_SIDR_CAPABLE                                      CL_HTON16(13)
+
#define IB_CM_RELIABLE_CONN_CAPABLE                     CL_HTON16(9)
+#define IB_CM_RELIABLE_DGRM_CAPABLE                     CL_HTON16(10)
+#define IB_CM_RDGRM_CAPABLE                                     CL_HTON16(11)
+#define IB_CM_UNRELIABLE_CONN_CAPABLE           CL_HTON16(12)
+#define IB_CM_SIDR_CAPABLE                                      CL_HTON16(13)
 

SEE ALSO

-
       ib_cm_rep, ib_class_port_info_t
+
       ib_cm_rep, ib_class_port_info_t
 

SOURCE

*
@@ -823,7 +828,7 @@ Access layer/ib_copy_ca_attr
 

[Definitions] Access Layer/ib_init_type_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_init_type_t
 
@@ -847,7 +852,7 @@ Access Layer/ib_init_type_t

[Structures] Access Layer/ib_local_ds_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_local_ds_t
 
@@ -871,7 +876,7 @@ Access Layer/ib_local_ds_t

[Structures] Access Layer/ib_mr_attr_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_mr_attr_t
 
@@ -938,7 +943,7 @@ Access Layer/ib_mr_attr_t

[Structures] Access Layer/ib_mr_create_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_mr_create_t
 
@@ -973,7 +978,7 @@ Access Layer/ib_mr_create_t

[Definitions] Access Layer/ib_mr_mod_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_mr_mod_t
 
@@ -1004,7 +1009,7 @@ Access Layer/ib_mr_mod_t

[Definitions] Access Layer/ib_pd_type_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_pd_type_t
 
@@ -1040,7 +1045,7 @@ Access Layer/ib_pd_type_t

[Structures] Access Layer/ib_phys_create_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_phys_create_t
 
@@ -1089,7 +1094,7 @@ Access Layer/ib_phys_create_t

[Structures] Access Layer/ib_phys_range_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_phys_range_t
 
@@ -1123,7 +1128,7 @@ Access Layer/ib_phys_range_t

[Structures] Access Layer/ib_port_attr_mod_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_port_attr_mod_t
 
@@ -1138,7 +1143,7 @@ Access Layer/ib_port_attr_mod_t uint16_t qkey_ctr; ib_init_type_t init_type; - ib_net64_t system_image_guid; + ib_net64_t system_image_guid; } ib_port_attr_mod_t;
@@ -1151,7 +1156,7 @@ Access Layer/ib_port_attr_mod_t

[Structures] Access Layer/ib_port_attr_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_port_attr_t
 
@@ -1161,11 +1166,11 @@ Access Layer/ib_port_attr_t

SYNOPSIS

typedef struct _ib_port_attr
 {
-        ib_net64_t                              port_guid;
+        ib_net64_t                              port_guid;
         uint8_t                                 port_num;
         uint8_t                                 mtu;
         uint64_t                                max_msg_size;
-        ib_net16_t                              lid;
+        ib_net16_t                              lid;
         uint8_t                                 lmc;
 
         /*
@@ -1176,7 +1181,7 @@ Access Layer/ib_port_attr_t
 
         uint16_t                                max_vls;
 
-        ib_net16_t                              sm_lid;
+        ib_net16_t                              sm_lid;
         uint8_t                                 sm_sl;
         uint8_t                                 link_state;
 
@@ -1202,13 +1207,13 @@ Access Layer/ib_port_attr_t
          * Pointers at the end of the structure to allow doing a simple
          * memory comparison of contents up to the first pointer.
          */
-        ib_gid_t* __ptr64               p_gid_table;
-        ib_net16_t* __ptr64             p_pkey_table;
+        ib_gid_t* __ptr64               p_gid_table;
+        ib_net16_t* __ptr64             p_pkey_table;
 
 }       ib_port_attr_t;
 

SEE ALSO

-
       uint8_t, ib_port_cap_t, ib_link_states_t
+
       uint8_t, ib_port_cap_t, ib_link_states_t
 

@@ -1216,7 +1221,7 @@ Access Layer/ib_port_attr_t

[Structures] Access Layer/ib_port_cap_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_port_cap_t
 
@@ -1262,7 +1267,7 @@ Access Layer/ib_port_cap_t

[Structures] Access Layer/ib_qp_attr_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_qp_attr_t
 
@@ -1291,12 +1296,12 @@ Access Layer/ib_qp_attr_t boolean_t sq_signaled; ib_qp_state_t state; - ib_net32_t num; - ib_net32_t dest_num; - ib_net32_t qkey; + ib_net32_t num; + ib_net32_t dest_num; + ib_net32_t qkey; - ib_net32_t sq_psn; - ib_net32_t rq_psn; + ib_net32_t sq_psn; + ib_net32_t rq_psn; uint8_t primary_port; uint8_t alternate_port; @@ -1326,7 +1331,7 @@ Access Layer/ib_qp_attr_t

[Structures] Access Layer/ib_qp_create_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_qp_create_t
 
@@ -1405,7 +1410,7 @@ Access Layer/ib_qp_create_t

[Structures] Access Layer/ib_qp_mod_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_qp_mod_t
 
@@ -1423,7 +1428,7 @@ Access Layer/ib_qp_mod_t struct _qp_init { uint8_t primary_port; - ib_net32_t qkey; + ib_net32_t qkey; uint16_t pkey_index; ib_access_t access_ctrl; @@ -1431,15 +1436,15 @@ Access Layer/ib_qp_mod_t struct _qp_rtr { - ib_net32_t rq_psn; - ib_net32_t dest_qp; + ib_net32_t rq_psn; + ib_net32_t dest_qp; ib_av_attr_t primary_av; uint8_t resp_res; uint8_t rnr_nak_timeout; ib_qp_opts_t opts; ib_av_attr_t alternate_av; - ib_net32_t qkey; + ib_net32_t qkey; uint16_t pkey_index; ib_access_t access_ctrl; uint32_t sq_depth; @@ -1449,7 +1454,7 @@ Access Layer/ib_qp_mod_t struct _qp_rts { - ib_net32_t sq_psn; + ib_net32_t sq_psn; uint8_t retry_cnt; uint8_t rnr_retry_cnt; uint8_t local_ack_timeout; @@ -1458,7 +1463,7 @@ Access Layer/ib_qp_mod_t ib_qp_opts_t opts; uint8_t rnr_nak_timeout; ib_qp_state_t current_state; - ib_net32_t qkey; + ib_net32_t qkey; ib_access_t access_ctrl; uint8_t resp_res; @@ -1493,7 +1498,7 @@ Access Layer/ib_qp_mod_t

[Definitions] Access Layer/ib_qp_opts_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_qp_opts_t
 
@@ -1528,7 +1533,7 @@ Access Layer/ib_qp_opts_t

[Definitions] Access Layer/ib_qp_state_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_qp_state_t
 
@@ -1556,7 +1561,7 @@ Access Layer/ib_qp_state_t

[Definitions] Access Layer/ib_qp_type_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_qp_type_t
 
@@ -1622,7 +1627,7 @@ Access Layer/ib_qp_type_t

[Definitions] Access Layer/ib_recv_opt_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_recv_opt_t
 
@@ -1659,7 +1664,7 @@ Access Layer/ib_recv_opt_t

[Structures] Access Layer/ib_recv_wr_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_recv_wr_t
 
@@ -1703,7 +1708,7 @@ Access Layer/ib_recv_wr_t

[Definitions] Access Layer/ib_rej_status_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_rej_status_t
 
@@ -1711,44 +1716,44 @@ Access Layer/ib_rej_status_t
       Rejection reasons.
 

SYNOPSIS

-
typedef ib_net16_t                                                      ib_rej_status_t;
+
typedef ib_net16_t                                                      ib_rej_status_t;
 

SEE ALSO

       ib_cm_rej, ib_cm_rej_rec_t
 

SOURCE

-
#define IB_REJ_INSUF_QP                                         CL_HTON16(1)
-#define IB_REJ_INSUF_EEC                                        CL_HTON16(2)
-#define IB_REJ_INSUF_RESOURCES                          CL_HTON16(3)
-#define IB_REJ_TIMEOUT                                          CL_HTON16(4)
-#define IB_REJ_UNSUPPORTED                                      CL_HTON16(5)
-#define IB_REJ_INVALID_COMM_ID                          CL_HTON16(6)
-#define IB_REJ_INVALID_COMM_INSTANCE            CL_HTON16(7)
-#define IB_REJ_INVALID_SID                                      CL_HTON16(8)
-#define IB_REJ_INVALID_XPORT                            CL_HTON16(9)
-#define IB_REJ_STALE_CONN                                       CL_HTON16(10)
-#define IB_REJ_RDC_NOT_EXIST                            CL_HTON16(11)
-#define IB_REJ_INVALID_GID                                      CL_HTON16(12)
-#define IB_REJ_INVALID_LID                                      CL_HTON16(13)
-#define IB_REJ_INVALID_SL                                       CL_HTON16(14)
-#define IB_REJ_INVALID_TRAFFIC_CLASS            CL_HTON16(15)
-#define IB_REJ_INVALID_HOP_LIMIT                        CL_HTON16(16)
-#define IB_REJ_INVALID_PKT_RATE                         CL_HTON16(17)
-#define IB_REJ_INVALID_ALT_GID                          CL_HTON16(18)
-#define IB_REJ_INVALID_ALT_LID                          CL_HTON16(19)
-#define IB_REJ_INVALID_ALT_SL                           CL_HTON16(20)
-#define IB_REJ_INVALID_ALT_TRAFFIC_CLASS        CL_HTON16(21)
-#define IB_REJ_INVALID_ALT_HOP_LIMIT            CL_HTON16(22)
-#define IB_REJ_INVALID_ALT_PKT_RATE                     CL_HTON16(23)
-#define IB_REJ_PORT_REDIRECT                            CL_HTON16(24)
-#define IB_REJ_INVALID_MTU                                      CL_HTON16(26)
-#define IB_REJ_INSUFFICIENT_RESP_RES            CL_HTON16(27)
-#define IB_REJ_USER_DEFINED                                     CL_HTON16(28)
-#define IB_REJ_INVALID_RNR_RETRY                        CL_HTON16(29)
-#define IB_REJ_DUPLICATE_LOCAL_COMM_ID          CL_HTON16(30)
-#define IB_REJ_INVALID_CLASS_VER                        CL_HTON16(31)
-#define IB_REJ_INVALID_FLOW_LBL                         CL_HTON16(32)
-#define IB_REJ_INVALID_ALT_FLOW_LBL                     CL_HTON16(33)
+
#define IB_REJ_INSUF_QP                                         CL_HTON16(1)
+#define IB_REJ_INSUF_EEC                                        CL_HTON16(2)
+#define IB_REJ_INSUF_RESOURCES                          CL_HTON16(3)
+#define IB_REJ_TIMEOUT                                          CL_HTON16(4)
+#define IB_REJ_UNSUPPORTED                                      CL_HTON16(5)
+#define IB_REJ_INVALID_COMM_ID                          CL_HTON16(6)
+#define IB_REJ_INVALID_COMM_INSTANCE            CL_HTON16(7)
+#define IB_REJ_INVALID_SID                                      CL_HTON16(8)
+#define IB_REJ_INVALID_XPORT                            CL_HTON16(9)
+#define IB_REJ_STALE_CONN                                       CL_HTON16(10)
+#define IB_REJ_RDC_NOT_EXIST                            CL_HTON16(11)
+#define IB_REJ_INVALID_GID                                      CL_HTON16(12)
+#define IB_REJ_INVALID_LID                                      CL_HTON16(13)
+#define IB_REJ_INVALID_SL                                       CL_HTON16(14)
+#define IB_REJ_INVALID_TRAFFIC_CLASS            CL_HTON16(15)
+#define IB_REJ_INVALID_HOP_LIMIT                        CL_HTON16(16)
+#define IB_REJ_INVALID_PKT_RATE                         CL_HTON16(17)
+#define IB_REJ_INVALID_ALT_GID                          CL_HTON16(18)
+#define IB_REJ_INVALID_ALT_LID                          CL_HTON16(19)
+#define IB_REJ_INVALID_ALT_SL                           CL_HTON16(20)
+#define IB_REJ_INVALID_ALT_TRAFFIC_CLASS        CL_HTON16(21)
+#define IB_REJ_INVALID_ALT_HOP_LIMIT            CL_HTON16(22)
+#define IB_REJ_INVALID_ALT_PKT_RATE                     CL_HTON16(23)
+#define IB_REJ_PORT_REDIRECT                            CL_HTON16(24)
+#define IB_REJ_INVALID_MTU                                      CL_HTON16(26)
+#define IB_REJ_INSUFFICIENT_RESP_RES            CL_HTON16(27)
+#define IB_REJ_USER_DEFINED                                     CL_HTON16(28)
+#define IB_REJ_INVALID_RNR_RETRY                        CL_HTON16(29)
+#define IB_REJ_DUPLICATE_LOCAL_COMM_ID          CL_HTON16(30)
+#define IB_REJ_INVALID_CLASS_VER                        CL_HTON16(31)
+#define IB_REJ_INVALID_FLOW_LBL                         CL_HTON16(32)
+#define IB_REJ_INVALID_ALT_FLOW_LBL                     CL_HTON16(33)
 

@@ -1756,7 +1761,7 @@ Access Layer/ib_rej_status_t

[Definitions] Access Layer/ib_send_opt_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_send_opt_t
 
@@ -1817,7 +1822,7 @@ Access Layer/ib_send_opt_t

[Structures] Access Layer/ib_send_wr_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_send_wr_t
 
@@ -1834,14 +1839,14 @@ Access Layer/ib_send_wr_t ib_send_opt_t send_opt; uint32_t num_ds; ib_local_ds_t* __ptr64 ds_array; - ib_net32_t immediate_data; + ib_net32_t immediate_data; union _send_dgrm { struct _send_ud { - ib_net32_t remote_qp; - ib_net32_t remote_qkey; + ib_net32_t remote_qp; + ib_net32_t remote_qkey; ib_av_handle_t h_av; uint16_t pkey_index; void* __ptr64 rsvd; @@ -1850,17 +1855,17 @@ Access Layer/ib_send_wr_t struct _send_raw_ether { - ib_net16_t dest_lid; + ib_net16_t dest_lid; uint8_t path_bits; uint8_t sl; uint8_t max_static_rate; - ib_net16_t ether_type; + ib_net16_t ether_type; } raw_ether; struct _send_raw_ipv6 { - ib_net16_t dest_lid; + ib_net16_t dest_lid; uint8_t path_bits; uint8_t sl; uint8_t max_static_rate; @@ -1874,8 +1879,8 @@ Access Layer/ib_send_wr_t uint64_t vaddr; net32_t rkey; - ib_net64_t atomic1; - ib_net64_t atomic2; + ib_net64_t atomic1; + ib_net64_t atomic2; } remote_ops; @@ -1987,7 +1992,7 @@ Access Layer/ib_send_wr_t

[Definitions] Access Layer/ib_wc_status_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_wc_status_t
 
@@ -2102,7 +2107,7 @@ Access Layer/ib_wc_status_t

[Structures] Access Layer/ib_wc_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_wc_t
 
@@ -2125,17 +2130,17 @@ Access Layer/ib_wc_t struct _wc_conn { ib_recv_opt_t recv_opt; - ib_net32_t immediate_data; + ib_net32_t immediate_data; } conn; struct _wc_ud { ib_recv_opt_t recv_opt; - ib_net32_t immediate_data; - ib_net32_t remote_qp; + ib_net32_t immediate_data; + ib_net32_t remote_qp; uint16_t pkey_index; - ib_net16_t remote_lid; + ib_net16_t remote_lid; uint8_t remote_sl; uint8_t path_bits; @@ -2143,7 +2148,7 @@ Access Layer/ib_wc_t struct _wc_raw_ipv6 { - ib_net16_t remote_lid; + ib_net16_t remote_lid; uint8_t remote_sl; uint8_t path_bits; @@ -2151,10 +2156,10 @@ Access Layer/ib_wc_t struct _wc_raw_ether { - ib_net16_t remote_lid; + ib_net16_t remote_lid; uint8_t remote_sl; uint8_t path_bits; - ib_net16_t ether_type; + ib_net16_t ether_type; } raw_ether; @@ -2259,7 +2264,7 @@ Access Layer/ib_wc_t

[Definitions] Access Layer/ib_wc_type_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_wc_type_t
 
@@ -2287,7 +2292,7 @@ Access Layer/ib_wc_type_t

[Definitions] Access Layer/ib_wr_type_t

-

[top][index]

+

[top][parent][index]

NAME

       ib_wr_type_t
 
@@ -2312,7 +2317,7 @@ Access Layer/ib_wr_type_t

[Structures] Access Layer/mlnx_fmr_create_t

-

[top][index]

+

[top][parent][index]

NAME

       mlnx_fmr_create_t
 
@@ -2351,7 +2356,7 @@ Access Layer/mlnx_fmr_create_t

-

[Structures] +

[Structures] IBA Base: Constants/IB_CLASS_CAP_GETSET

[top][index]

@@ -2363,7 +2368,7 @@ IBA Base: Constants/IB_CLASS_CAP_GETSET

if the class supports Get(Notice) and Set(Notice) MADs (13.4.8.1).

SEE ALSO

-
       ib_class_port_info_t, IB_CLASS_CAP_TRAP
+
       ib_class_port_info_t, IB_CLASS_CAP_TRAP
 

SOURCE

#define IB_CLASS_CAP_GETSET                                     0x0002
@@ -2371,7 +2376,7 @@ IBA Base: Constants/IB_CLASS_CAP_GETSET
 
 
-

[Structures] +

[Structures] IBA Base: Constants/IB_CLASS_CAP_TRAP

[top][index]

@@ -2383,7 +2388,7 @@ IBA Base: Constants/IB_CLASS_CAP_TRAP

if the class supports Trap() MADs (13.4.8.1).

SEE ALSO

-
       ib_class_port_info_t, IB_CLASS_CAP_GETSET
+
       ib_class_port_info_t, IB_CLASS_CAP_GETSET
 

SOURCE

#define IB_CLASS_CAP_TRAP                                       0x0001
@@ -2391,7 +2396,7 @@ IBA Base: Constants/IB_CLASS_CAP_TRAP
 
 
-

[Structures] +

[Structures] IBA Base: Constants/IB_CLASS_RESP_TIME_MASK

[top][index]

@@ -2400,10 +2405,10 @@ IBA Base: Constants/IB_CLASS_RESP_TIME_MASK

DESCRIPTION

       Mask bits to extract the reponse time value from the
-       resp_time_val field of ib_class_port_info_t.
+       resp_time_val field of ib_class_port_info_t.
 

SEE ALSO

-
       ib_class_port_info_t
+
       ib_class_port_info_t
 

SOURCE

#define IB_CLASS_RESP_TIME_MASK                         0x1F
@@ -2411,7 +2416,7 @@ IBA Base: Constants/IB_CLASS_RESP_TIME_MASK
 
 
-

[Definitions] +

[Definitions] IBA Base: Constants/IB_DEFAULT_PKEY

[top][index]

@@ -2427,7 +2432,7 @@ IBA Base: Constants/IB_DEFAULT_PKEY


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_DEFAULT_SUBNET_PREFIX

[top][index]

@@ -2438,12 +2443,12 @@ IBA Base: Constants/IB_DEFAULT_SUBNET_PREFIX

       Default subnet GID prefix.
 

SOURCE

-
#define IB_DEFAULT_SUBNET_PREFIX                        (CL_HTON64(CL_CONST64(0xFE80000000000000)))
+
#define IB_DEFAULT_SUBNET_PREFIX                        (CL_HTON64(CL_CONST64(0xFE80000000000000)))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_INVALID_PORT_NUM

[top][index]

@@ -2459,7 +2464,7 @@ IBA Base: Constants/IB_INVALID_PORT_NUM


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_LID_MCAST_END

[top][index]

@@ -2471,12 +2476,12 @@ IBA Base: Constants/IB_LID_MCAST_END

SOURCE

#define IB_LID_MCAST_END_HO                                     0xFFFE
-#define IB_LID_MCAST_END                                        (CL_HTON16(IB_LID_MCAST_END_HO))
+#define IB_LID_MCAST_END                                        (CL_HTON16(IB_LID_MCAST_END_HO))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_LID_MCAST_START

[top][index]

@@ -2488,12 +2493,12 @@ IBA Base: Constants/IB_LID_MCAST_START

SOURCE

#define IB_LID_MCAST_START_HO                           0xC000
-#define IB_LID_MCAST_START                                      (CL_HTON16(IB_LID_MCAST_START_HO))
+#define IB_LID_MCAST_START                                      (CL_HTON16(IB_LID_MCAST_START_HO))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_LID_PERMISSIVE

[top][index]

@@ -2509,7 +2514,7 @@ IBA Base: Constants/IB_LID_PERMISSIVE


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_LID_UCAST_END

[top][index]

@@ -2521,12 +2526,12 @@ IBA Base: Constants/IB_LID_UCAST_END

SOURCE

#define IB_LID_UCAST_END_HO                                     0xBFFF
-#define IB_LID_UCAST_END                                        (CL_HTON16(IB_LID_UCAST_END_HO))
+#define IB_LID_UCAST_END                                        (CL_HTON16(IB_LID_UCAST_END_HO))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_LID_UCAST_START

[top][index]

@@ -2538,12 +2543,12 @@ IBA Base: Constants/IB_LID_UCAST_START

SOURCE

#define IB_LID_UCAST_START_HO                           0x0001
-#define IB_LID_UCAST_START                                      (CL_HTON16(IB_LID_UCAST_START_HO))
+#define IB_LID_UCAST_START                                      (CL_HTON16(IB_LID_UCAST_START_HO))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/ib_link_states_t

[top][index]

@@ -2564,7 +2569,7 @@ IBA Base: Constants/ib_link_states_t


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_CLASS_PORT_INFO

[top][index]

@@ -2575,12 +2580,12 @@ IBA Base: Constants/IB_MAD_ATTR_CLASS_PORT_INFO

       ClassPortInfo attribute (13.4.8)
 

SOURCE

-
#define IB_MAD_ATTR_CLASS_PORT_INFO                     (CL_NTOH16(0x0001))
+
#define IB_MAD_ATTR_CLASS_PORT_INFO                     (CL_NTOH16(0x0001))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_DIAG_CODE

[top][index]

@@ -2591,12 +2596,12 @@ IBA Base: Constants/IB_MAD_ATTR_DIAG_CODE

       DiagCode attribute (16.3.3)
 

SOURCE

-
#define IB_MAD_ATTR_DIAG_CODE                           (CL_NTOH16(0x0024))
+
#define IB_MAD_ATTR_DIAG_CODE                           (CL_NTOH16(0x0024))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_DIAGNOSTIC_TIMEOUT

[top][index]

@@ -2607,12 +2612,12 @@ IBA Base: Constants/IB_MAD_ATTR_DIAGNOSTIC_TIMEOUT

       DiagnosticTimeout attribute (16.3.3)
 

SOURCE

-
#define IB_MAD_ATTR_DIAGNOSTIC_TIMEOUT          (CL_NTOH16(0x0020))
+
#define IB_MAD_ATTR_DIAGNOSTIC_TIMEOUT          (CL_NTOH16(0x0020))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_GUID_INFO

[top][index]

@@ -2623,12 +2628,12 @@ IBA Base: Constants/IB_MAD_ATTR_GUID_INFO

       GUIDInfo attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_GUID_INFO                           (CL_NTOH16(0x0014))
+
#define IB_MAD_ATTR_GUID_INFO                           (CL_NTOH16(0x0014))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_INFORM_INFO

[top][index]

@@ -2639,12 +2644,12 @@ IBA Base: Constants/IB_MAD_ATTR_INFORM_INFO

       InformInfo attribute (13.4.8)
 

SOURCE

-
#define IB_MAD_ATTR_INFORM_INFO                         (CL_NTOH16(0x0003))
+
#define IB_MAD_ATTR_INFORM_INFO                         (CL_NTOH16(0x0003))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_IO_UNIT_INFO

[top][index]

@@ -2655,12 +2660,12 @@ IBA Base: Constants/IB_MAD_ATTR_IO_UNIT_INFO

       IOUnitInfo attribute (16.3.3)
 

SOURCE

-
#define IB_MAD_ATTR_IO_UNIT_INFO                        (CL_NTOH16(0x0010))
+
#define IB_MAD_ATTR_IO_UNIT_INFO                        (CL_NTOH16(0x0010))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_IOC_PROFILE

[top][index]

@@ -2671,12 +2676,12 @@ IBA Base: Constants/IB_MAD_ATTR_IOC_PROFILE

       IOControllerProfile attribute (16.3.3)
 

SOURCE

-
#define IB_MAD_ATTR_IOC_PROFILE                         (CL_NTOH16(0x0011))
+
#define IB_MAD_ATTR_IOC_PROFILE                         (CL_NTOH16(0x0011))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_LED_INFO

[top][index]

@@ -2687,12 +2692,12 @@ IBA Base: Constants/IB_MAD_ATTR_LED_INFO

       LedInfo attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_LED_INFO                            (CL_NTOH16(0x0031))
+
#define IB_MAD_ATTR_LED_INFO                            (CL_NTOH16(0x0031))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_LFT_RECORD

[top][index]

@@ -2703,12 +2708,12 @@ IBA Base: Constants/IB_MAD_ATTR_LFT_RECORD

       LinearForwardingRecord attribute (15.2.5.6)
 

SOURCE

-
#define IB_MAD_ATTR_LFT_RECORD                  (CL_NTOH16(0x0015))
+
#define IB_MAD_ATTR_LFT_RECORD                  (CL_NTOH16(0x0015))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_LIN_FWD_TBL

[top][index]

@@ -2719,12 +2724,12 @@ IBA Base: Constants/IB_MAD_ATTR_LIN_FWD_TBL

       Switch linear forwarding table
 

SOURCE

-
#define IB_MAD_ATTR_LIN_FWD_TBL                         (CL_NTOH16(0x0019))
+
#define IB_MAD_ATTR_LIN_FWD_TBL                         (CL_NTOH16(0x0019))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_LINK_RECORD

[top][index]

@@ -2735,12 +2740,12 @@ IBA Base: Constants/IB_MAD_ATTR_LINK_RECORD

       LinkRecord attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_LINK_RECORD                         (CL_NTOH16(0x0020))
+
#define IB_MAD_ATTR_LINK_RECORD                         (CL_NTOH16(0x0020))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_MCAST_FWD_TBL

[top][index]

@@ -2751,12 +2756,12 @@ IBA Base: Constants/IB_MAD_ATTR_MCAST_FWD_TBL

       Switch multicast forwarding table
 

SOURCE

-
#define IB_MAD_ATTR_MCAST_FWD_TBL                       (CL_NTOH16(0x001B))
+
#define IB_MAD_ATTR_MCAST_FWD_TBL                       (CL_NTOH16(0x001B))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_MCMEMBER_RECORD

[top][index]

@@ -2767,12 +2772,12 @@ IBA Base: Constants/IB_MAD_ATTR_MCMEMBER_RECORD

       MCMemberRecord attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_MCMEMBER_RECORD                     (CL_NTOH16(0x0038))
+
#define IB_MAD_ATTR_MCMEMBER_RECORD                     (CL_NTOH16(0x0038))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_MULTIPATH_RECORD

[top][index]

@@ -2783,12 +2788,12 @@ IBA Base: Constants/IB_MAD_ATTR_MULTIPATH_RECORD

       MultiPath attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_MULTIPATH_RECORD                    (CL_NTOH16(0x003A))
+
#define IB_MAD_ATTR_MULTIPATH_RECORD                    (CL_NTOH16(0x003A))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_NODE_DESC

[top][index]

@@ -2799,12 +2804,12 @@ IBA Base: Constants/IB_MAD_ATTR_NODE_DESC

       NodeDescription attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_NODE_DESC                           (CL_NTOH16(0x0010))
+
#define IB_MAD_ATTR_NODE_DESC                           (CL_NTOH16(0x0010))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_NODE_INFO

[top][index]

@@ -2815,12 +2820,12 @@ IBA Base: Constants/IB_MAD_ATTR_NODE_INFO

       NodeInfo attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_NODE_INFO                           (CL_NTOH16(0x0011))
+
#define IB_MAD_ATTR_NODE_INFO                           (CL_NTOH16(0x0011))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_NODE_RECORD

[top][index]

@@ -2831,12 +2836,12 @@ IBA Base: Constants/IB_MAD_ATTR_NODE_RECORD

       NodeRecord attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_NODE_RECORD                         (CL_NTOH16(0x0011))
+
#define IB_MAD_ATTR_NODE_RECORD                         (CL_NTOH16(0x0011))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_NOTICE

[top][index]

@@ -2847,12 +2852,12 @@ IBA Base: Constants/IB_MAD_ATTR_NOTICE

       Notice attribute (13.4.8)
 

SOURCE

-
#define IB_MAD_ATTR_NOTICE                                      (CL_NTOH16(0x0002))
+
#define IB_MAD_ATTR_NOTICE                                      (CL_NTOH16(0x0002))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_P_KEY_TABLE

[top][index]

@@ -2863,12 +2868,12 @@ IBA Base: Constants/IB_MAD_ATTR_P_KEY_TABLE

       PartitionTable attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_P_KEY_TABLE                         (CL_NTOH16(0x0016))
+
#define IB_MAD_ATTR_P_KEY_TABLE                         (CL_NTOH16(0x0016))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_PATH_RECORD

[top][index]

@@ -2879,12 +2884,12 @@ IBA Base: Constants/IB_MAD_ATTR_PATH_RECORD

       PathRecord attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_PATH_RECORD                         (CL_NTOH16(0x0035))
+
#define IB_MAD_ATTR_PATH_RECORD                         (CL_NTOH16(0x0035))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_PKEYTBL_RECORD

[top][index]

@@ -2895,12 +2900,12 @@ IBA Base: Constants/IB_MAD_ATTR_PKEYTBL_RECORD

       P-KEY table attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_PKEY_TBL_RECORD                     (CL_NTOH16(0x0033))
+
#define IB_MAD_ATTR_PKEY_TBL_RECORD                     (CL_NTOH16(0x0033))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_PORT_CNTRS

[top][index]

@@ -2911,12 +2916,12 @@ IBA Base: Constants/IB_MAD_ATTR_PORT_CNTRS

       SwitchInfo attribute (16.1.2)
 

SOURCE

-
#define IB_MAD_ATTR_PORT_CNTRS                          (CL_NTOH16(0x0012))
+
#define IB_MAD_ATTR_PORT_CNTRS                          (CL_NTOH16(0x0012))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_PORT_INFO

[top][index]

@@ -2927,12 +2932,12 @@ IBA Base: Constants/IB_MAD_ATTR_PORT_INFO

       PortInfo attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_PORT_INFO                           (CL_NTOH16(0x0015))
+
#define IB_MAD_ATTR_PORT_INFO                           (CL_NTOH16(0x0015))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_PORT_SMPL_CTRL

[top][index]

@@ -2943,12 +2948,12 @@ IBA Base: Constants/IB_MAD_ATTR_PORT_SMPL_CTRL

       NodeDescription attribute (16.1.2)
 

SOURCE

-
#define IB_MAD_ATTR_PORT_SMPL_CTRL                      (CL_NTOH16(0x0010))
+
#define IB_MAD_ATTR_PORT_SMPL_CTRL                      (CL_NTOH16(0x0010))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_PORT_SMPL_RSLT

[top][index]

@@ -2959,12 +2964,12 @@ IBA Base: Constants/IB_MAD_ATTR_PORT_SMPL_RSLT

       NodeInfo attribute (16.1.2)
 

SOURCE

-
#define IB_MAD_ATTR_PORT_SMPL_RSLT                      (CL_NTOH16(0x0011))
+
#define IB_MAD_ATTR_PORT_SMPL_RSLT                      (CL_NTOH16(0x0011))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_PORTINFO_RECORD

[top][index]

@@ -2975,12 +2980,12 @@ IBA Base: Constants/IB_MAD_ATTR_PORTINFO_RECORD

       PortInfoRecord attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_PORTINFO_RECORD                     (CL_NTOH16(0x0012))
+
#define IB_MAD_ATTR_PORTINFO_RECORD                     (CL_NTOH16(0x0012))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_PREPARE_TO_TEST

[top][index]

@@ -2991,12 +2996,12 @@ IBA Base: Constants/IB_MAD_ATTR_PREPARE_TO_TEST

       PrepareToTest attribute (16.3.3)
 

SOURCE

-
#define IB_MAD_ATTR_PREPARE_TO_TEST                     (CL_NTOH16(0x0021))
+
#define IB_MAD_ATTR_PREPARE_TO_TEST                     (CL_NTOH16(0x0021))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_RND_FWD_TBL

[top][index]

@@ -3007,12 +3012,12 @@ IBA Base: Constants/IB_MAD_ATTR_RND_FWD_TBL

       Switch random forwarding table
 

SOURCE

-
#define IB_MAD_ATTR_RND_FWD_TBL                         (CL_NTOH16(0x001A))
+
#define IB_MAD_ATTR_RND_FWD_TBL                         (CL_NTOH16(0x001A))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_SERVICE_ENTRIES

[top][index]

@@ -3023,12 +3028,12 @@ IBA Base: Constants/IB_MAD_ATTR_SERVICE_ENTRIES

       ServiceEntries attribute (16.3.3)
 

SOURCE

-
#define IB_MAD_ATTR_SERVICE_ENTRIES                     (CL_NTOH16(0x0012))
+
#define IB_MAD_ATTR_SERVICE_ENTRIES                     (CL_NTOH16(0x0012))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_SERVICE_RECORD

[top][index]

@@ -3039,12 +3044,12 @@ IBA Base: Constants/IB_MAD_ATTR_SERVICE_RECORD

       ServiceRecord attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_SERVICE_RECORD                      (CL_NTOH16(0x0031))
+
#define IB_MAD_ATTR_SERVICE_RECORD                      (CL_NTOH16(0x0031))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_SLVL_RECORD

[top][index]

@@ -3052,15 +3057,15 @@ IBA Base: Constants/IB_MAD_ATTR_SLVL_RECORD

       IB_MAD_ATTR_SLVL_RECORD
 

DESCRIPTION

-
       VSLtoL Map Table attribute (15.2.5)
+
       VSLtoL Map Table attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_SLVL_RECORD                         (CL_NTOH16(0x0013))
+
#define IB_MAD_ATTR_SLVL_RECORD                         (CL_NTOH16(0x0013))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_SLVL_TABLE

[top][index]

@@ -3071,12 +3076,12 @@ IBA Base: Constants/IB_MAD_ATTR_SLVL_TABLE

       SL VL Mapping Table attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_SLVL_TABLE                          (CL_NTOH16(0x0017))
+
#define IB_MAD_ATTR_SLVL_TABLE                          (CL_NTOH16(0x0017))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_SM_INFO

[top][index]

@@ -3087,12 +3092,12 @@ IBA Base: Constants/IB_MAD_ATTR_SM_INFO

       SMInfo attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_SM_INFO                                     (CL_NTOH16(0x0020))
+
#define IB_MAD_ATTR_SM_INFO                                     (CL_NTOH16(0x0020))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_SMINFO_RECORD

[top][index]

@@ -3103,12 +3108,12 @@ IBA Base: Constants/IB_MAD_ATTR_SMINFO_RECORD

       SmInfoRecord attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_SMINFO_RECORD                       (CL_NTOH16(0x0018))
+
#define IB_MAD_ATTR_SMINFO_RECORD                       (CL_NTOH16(0x0018))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_SVC_ASSOCIATION_RECORD

[top][index]

@@ -3119,12 +3124,12 @@ IBA Base: Constants/IB_MAD_ATTR_SVC_ASSOCIATION_RECORD

       Service Association attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_SVC_ASSOCIATION_RECORD              (CL_NTOH16(0x003B))
+
#define IB_MAD_ATTR_SVC_ASSOCIATION_RECORD              (CL_NTOH16(0x003B))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_SWITCH_INFO

[top][index]

@@ -3135,12 +3140,12 @@ IBA Base: Constants/IB_MAD_ATTR_SWITCH_INFO

       SwitchInfo attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_SWITCH_INFO                         (CL_NTOH16(0x0012))
+
#define IB_MAD_ATTR_SWITCH_INFO                         (CL_NTOH16(0x0012))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_TEST_DEVICE_LOOP

[top][index]

@@ -3151,12 +3156,12 @@ IBA Base: Constants/IB_MAD_ATTR_TEST_DEVICE_LOOP

       TestDeviceLoop attribute (16.3.3)
 

SOURCE

-
#define IB_MAD_ATTR_TEST_DEVICE_LOOP            (CL_NTOH16(0x0023))
+
#define IB_MAD_ATTR_TEST_DEVICE_LOOP            (CL_NTOH16(0x0023))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_TEST_DEVICE_ONCE

[top][index]

@@ -3167,12 +3172,12 @@ IBA Base: Constants/IB_MAD_ATTR_TEST_DEVICE_ONCE

       TestDeviceOnce attribute (16.3.3)
 

SOURCE

-
#define IB_MAD_ATTR_TEST_DEVICE_ONCE            (CL_NTOH16(0x0022))
+
#define IB_MAD_ATTR_TEST_DEVICE_ONCE            (CL_NTOH16(0x0022))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_TRACE_RECORD

[top][index]

@@ -3183,12 +3188,12 @@ IBA Base: Constants/IB_MAD_ATTR_TRACE_RECORD

       TraceRecord attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_TRACE_RECORD                        (CL_NTOH16(0x0039))
+
#define IB_MAD_ATTR_TRACE_RECORD                        (CL_NTOH16(0x0039))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_VENDOR_DIAG

[top][index]

@@ -3199,12 +3204,12 @@ IBA Base: Constants/IB_MAD_ATTR_VENDOR_DIAG

       VendorDiag attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_VENDOR_DIAG                         (CL_NTOH16(0x0030))
+
#define IB_MAD_ATTR_VENDOR_DIAG                         (CL_NTOH16(0x0030))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_VL_ARBITRATION

[top][index]

@@ -3215,12 +3220,12 @@ IBA Base: Constants/IB_MAD_ATTR_VL_ARBITRATION

       VL Arbitration Table attribute (14.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_VL_ARBITRATION                      (CL_NTOH16(0x0018))
+
#define IB_MAD_ATTR_VL_ARBITRATION                      (CL_NTOH16(0x0018))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_ATTR_VLARB_RECORD

[top][index]

@@ -3231,12 +3236,12 @@ IBA Base: Constants/IB_MAD_ATTR_VLARB_RECORD

       VL Arbitration Table attribute (15.2.5)
 

SOURCE

-
#define IB_MAD_ATTR_VLARB_RECORD                        (CL_NTOH16(0x0036))
+
#define IB_MAD_ATTR_VLARB_RECORD                        (CL_NTOH16(0x0036))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_GET

[top][index]

@@ -3252,7 +3257,7 @@ IBA Base: Constants/IB_MAD_METHOD_GET


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_GET_RESP

[top][index]

@@ -3268,7 +3273,7 @@ IBA Base: Constants/IB_MAD_METHOD_GET_RESP


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_GETTABLE

[top][index]

@@ -3284,7 +3289,7 @@ IBA Base: Constants/IB_MAD_METHOD_GETTABLE


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_GETTABLE_RESP

[top][index]

@@ -3300,7 +3305,7 @@ IBA Base: Constants/IB_MAD_METHOD_GETTABLE_RESP


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_REPORT

[top][index]

@@ -3316,7 +3321,7 @@ IBA Base: Constants/IB_MAD_METHOD_REPORT


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_REPORT_RESP

[top][index]

@@ -3332,7 +3337,7 @@ IBA Base: Constants/IB_MAD_METHOD_REPORT_RESP


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_RESP_MASK

[top][index]

@@ -3348,7 +3353,7 @@ IBA Base: Constants/IB_MAD_METHOD_RESP_MASK


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_SEND

[top][index]

@@ -3364,7 +3369,7 @@ IBA Base: Constants/IB_MAD_METHOD_SEND


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_SET

[top][index]

@@ -3380,7 +3385,7 @@ IBA Base: Constants/IB_MAD_METHOD_SET


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_TRAP

[top][index]

@@ -3396,7 +3401,7 @@ IBA Base: Constants/IB_MAD_METHOD_TRAP


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_METHOD_TRAP_REPRESS

[top][index]

@@ -3412,7 +3417,7 @@ IBA Base: Constants/IB_MAD_METHOD_TRAP_REPRESS


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_STATUS_BUSY

[top][index]

@@ -3423,12 +3428,12 @@ IBA Base: Constants/IB_MAD_STATUS_BUSY

       Temporarily busy, MAD discarded (13.4.7)
 

SOURCE

-
#define IB_MAD_STATUS_BUSY                                      (CL_HTON16(0x0001))
+
#define IB_MAD_STATUS_BUSY                                      (CL_HTON16(0x0001))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_STATUS_INVALID_FIELD

[top][index]

@@ -3439,12 +3444,12 @@ IBA Base: Constants/IB_MAD_STATUS_INVALID_FIELD

       Attribute contains one or more invalid fields (13.4.7)
 

SOURCE

-
#define IB_MAD_STATUS_INVALID_FIELD                     (CL_HTON16(0x001C))
+
#define IB_MAD_STATUS_INVALID_FIELD                     (CL_HTON16(0x001C))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_STATUS_REDIRECT

[top][index]

@@ -3455,12 +3460,12 @@ IBA Base: Constants/IB_MAD_STATUS_REDIRECT

       QP Redirection required (13.4.7)
 

SOURCE

-
#define IB_MAD_STATUS_REDIRECT                          (CL_HTON16(0x0002))
+
#define IB_MAD_STATUS_REDIRECT                          (CL_HTON16(0x0002))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_STATUS_UNSUP_CLASS_VER

[top][index]

@@ -3471,12 +3476,12 @@ IBA Base: Constants/IB_MAD_STATUS_UNSUP_CLASS_VER

       Unsupported class version (13.4.7)
 

SOURCE

-
#define IB_MAD_STATUS_UNSUP_CLASS_VER           (CL_HTON16(0x0004))
+
#define IB_MAD_STATUS_UNSUP_CLASS_VER           (CL_HTON16(0x0004))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_STATUS_UNSUP_METHOD

[top][index]

@@ -3487,12 +3492,12 @@ IBA Base: Constants/IB_MAD_STATUS_UNSUP_METHOD

       Unsupported method (13.4.7)
 

SOURCE

-
#define IB_MAD_STATUS_UNSUP_METHOD                      (CL_HTON16(0x0008))
+
#define IB_MAD_STATUS_UNSUP_METHOD                      (CL_HTON16(0x0008))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAD_STATUS_UNSUP_METHOD_ATTR

[top][index]

@@ -3503,12 +3508,12 @@ IBA Base: Constants/IB_MAD_STATUS_UNSUP_METHOD_ATTR

       Unsupported method/attribute combination (13.4.7)
 

SOURCE

-
#define IB_MAD_STATUS_UNSUP_METHOD_ATTR         (CL_HTON16(0x000C))
+
#define IB_MAD_STATUS_UNSUP_METHOD_ATTR         (CL_HTON16(0x000C))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MAX_METHOD

[top][index]

@@ -3524,7 +3529,7 @@ IBA Base: Constants/IB_MAX_METHOD


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCAST_BLOCK_ID_MASK_HO

[top][index]

@@ -3540,7 +3545,7 @@ IBA Base: Constants/IB_MCAST_BLOCK_ID_MASK_HO


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCAST_BLOCK_SIZE

[top][index]

@@ -3556,7 +3561,7 @@ IBA Base: Constants/IB_MCAST_BLOCK_SIZE


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCAST_MASK_SIZE

[top][index]

@@ -3572,7 +3577,7 @@ IBA Base: Constants/IB_MCAST_MASK_SIZE


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCAST_MAX_BLOCK_ID

[top][index]

@@ -3588,7 +3593,7 @@ IBA Base: Constants/IB_MCAST_MAX_BLOCK_ID


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCAST_POSITION_MASK_HO

[top][index]

@@ -3604,7 +3609,7 @@ IBA Base: Constants/IB_MCAST_POSITION_MASK_HO


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCAST_POSITION_MAX

[top][index]

@@ -3620,7 +3625,7 @@ IBA Base: Constants/IB_MCAST_POSITION_MAX


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCAST_POSITION_SHIFT

[top][index]

@@ -3636,7 +3641,7 @@ IBA Base: Constants/IB_MCAST_POSITION_SHIFT


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_BM

[top][index]

@@ -3652,7 +3657,7 @@ IBA Base: Constants/IB_MCLASS_BM


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_COMM_MGMT

[top][index]

@@ -3668,7 +3673,7 @@ IBA Base: Constants/IB_MCLASS_COMM_MGMT


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_DEV_MGMT

[top][index]

@@ -3684,7 +3689,7 @@ IBA Base: Constants/IB_MCLASS_DEV_MGMT


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_PERF

[top][index]

@@ -3700,7 +3705,7 @@ IBA Base: Constants/IB_MCLASS_PERF


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_SNMP

[top][index]

@@ -3716,7 +3721,7 @@ IBA Base: Constants/IB_MCLASS_SNMP


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_SUBN_ADM

[top][index]

@@ -3732,7 +3737,7 @@ IBA Base: Constants/IB_MCLASS_SUBN_ADM


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_SUBN_DIR

[top][index]

@@ -3748,7 +3753,7 @@ IBA Base: Constants/IB_MCLASS_SUBN_DIR


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_SUBN_LID

[top][index]

@@ -3764,7 +3769,7 @@ IBA Base: Constants/IB_MCLASS_SUBN_LID


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_VENDOR_HIGH_RANGE_MAX

[top][index]

@@ -3780,7 +3785,7 @@ IBA Base: Constants/IB_MCLASS_VENDOR_HIGH_RANGE_MAX


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_VENDOR_HIGH_RANGE_MIN

[top][index]

@@ -3796,7 +3801,7 @@ IBA Base: Constants/IB_MCLASS_VENDOR_HIGH_RANGE_MIN


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_VENDOR_LOW_RANGE_MAX

[top][index]

@@ -3812,7 +3817,7 @@ IBA Base: Constants/IB_MCLASS_VENDOR_LOW_RANGE_MAX


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MCLASS_VENDOR_LOW_RANGE_MIN

[top][index]

@@ -3828,7 +3833,7 @@ IBA Base: Constants/IB_MCLASS_VENDOR_LOW_RANGE_MIN


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_MTU_TYPE

[top][index]

@@ -3854,7 +3859,7 @@ IBA Base: Constants/IB_MTU_TYPE


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_NODE_NUM_PORTS_MAX

[top][index]

@@ -3870,7 +3875,7 @@ IBA Base: Constants/IB_NODE_NUM_PORTS_MAX


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_NODE_TYPE_CA

[top][index]

@@ -3886,7 +3891,7 @@ IBA Base: Constants/IB_NODE_TYPE_CA


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_NODE_TYPE_ROUTER

[top][index]

@@ -3902,7 +3907,7 @@ IBA Base: Constants/IB_NODE_TYPE_ROUTER


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_NODE_TYPE_SWITCH

[top][index]

@@ -3918,7 +3923,7 @@ IBA Base: Constants/IB_NODE_TYPE_SWITCH


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_NOTICE_NODE_TYPE_CA

[top][index]

@@ -3929,12 +3934,12 @@ IBA Base: Constants/IB_NOTICE_NODE_TYPE_CA

       Encoded generic node type used in MAD attributes (13.4.8.2)
 

SOURCE

-
#define IB_NOTICE_NODE_TYPE_CA                          (CL_NTOH32(0x000001))
+
#define IB_NOTICE_NODE_TYPE_CA                          (CL_NTOH32(0x000001))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_NOTICE_NODE_TYPE_ROUTER

[top][index]

@@ -3945,12 +3950,12 @@ IBA Base: Constants/IB_NOTICE_NODE_TYPE_ROUTER

       Encoded generic node type used in MAD attributes (13.4.8.2)
 

SOURCE

-
#define IB_NOTICE_NODE_TYPE_ROUTER                      (CL_NTOH32(0x000003))
+
#define IB_NOTICE_NODE_TYPE_ROUTER                      (CL_NTOH32(0x000003))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_NOTICE_NODE_TYPE_SUBN_MGMT

[top][index]

@@ -3963,12 +3968,12 @@ IBA Base: Constants/IB_NOTICE_NODE_TYPE_SUBN_MGMT

of the NodeInfo attribute (14.2.5.3).

SOURCE

-
#define IB_NOTICE_NODE_TYPE_SUBN_MGMT           (CL_NTOH32(0x000004))
+
#define IB_NOTICE_NODE_TYPE_SUBN_MGMT           (CL_NTOH32(0x000004))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_NOTICE_NODE_TYPE_SWITCH

[top][index]

@@ -3979,12 +3984,12 @@ IBA Base: Constants/IB_NOTICE_NODE_TYPE_SWITCH

       Encoded generic node type used in MAD attributes (13.4.8.2)
 

SOURCE

-
#define IB_NOTICE_NODE_TYPE_SWITCH                      (CL_NTOH32(0x000002))
+
#define IB_NOTICE_NODE_TYPE_SWITCH                      (CL_NTOH32(0x000002))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_PATH_REC_BASE_MASK

[top][index]

@@ -4001,7 +4006,7 @@ IBA Base: Constants/IB_PATH_REC_BASE_MASK


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_PATH_REC_SELECTOR_MASK

[top][index]

@@ -4018,7 +4023,7 @@ IBA Base: Constants/IB_PATH_REC_SELECTOR_MASK


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_PATH_SELECTOR_TYPE

[top][index]

@@ -4041,7 +4046,7 @@ IBA Base: Constants/IB_PATH_SELECTOR_TYPE


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_PKEY_BASE_MASK

[top][index]

@@ -4052,12 +4057,12 @@ IBA Base: Constants/IB_PKEY_BASE_MASK

       Masks for the base P_Key value given a P_Key Entry.
 

SOURCE

-
#define IB_PKEY_BASE_MASK                                       (CL_NTOH16(0x7FFF))
+
#define IB_PKEY_BASE_MASK                                       (CL_NTOH16(0x7FFF))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_PKEY_ENTRIES_MAX

[top][index]

@@ -4068,12 +4073,12 @@ IBA Base: Constants/IB_PKEY_ENTRIES_MAX

       Maximum number of PKEY entries per port (14.2.5.7).
 

SOURCE

-
#define IB_PKEY_ENTRIES_MAX (IB_PKEY_MAX_BLOCKS * IB_PKEY_BLOCK_SIZE)
+
#define IB_PKEY_ENTRIES_MAX (IB_PKEY_MAX_BLOCKS * IB_PKEY_BLOCK_SIZE)
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_PKEY_MAX_BLOCKS

[top][index]

@@ -4089,7 +4094,7 @@ IBA Base: Constants/IB_PKEY_MAX_BLOCKS


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_PKEY_TYPE_MASK

[top][index]

@@ -4100,12 +4105,12 @@ IBA Base: Constants/IB_PKEY_TYPE_MASK

       Masks for the P_Key membership type given a P_Key Entry.
 

SOURCE

-
#define IB_PKEY_TYPE_MASK                                       (CL_NTOH16(0x8000))
+
#define IB_PKEY_TYPE_MASK                                       (CL_NTOH16(0x8000))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_QP1_WELL_KNOWN_Q_KEY

[top][index]

@@ -4116,12 +4121,12 @@ IBA Base: Constants/IB_QP1_WELL_KNOWN_Q_KEY

       Well-known Q_Key for QP1 privileged mode access (15.4.2).
 

SOURCE

-
#define IB_QP1_WELL_KNOWN_Q_KEY                         CL_NTOH32(0x80010000)
+
#define IB_QP1_WELL_KNOWN_Q_KEY                         CL_NTOH32(0x80010000)
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_ATTR_MOD_ACKNOWLEDGE

[top][index]

@@ -4132,12 +4137,12 @@ IBA Base: Constants/IB_SMINFO_ATTR_MOD_ACKNOWLEDGE

       Encoded attribute modifier value used on SubnSet(SMInfo) SMPs.
 

SOURCE

-
#define IB_SMINFO_ATTR_MOD_ACKNOWLEDGE          (CL_NTOH32(0x000002))
+
#define IB_SMINFO_ATTR_MOD_ACKNOWLEDGE          (CL_NTOH32(0x000002))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_ATTR_MOD_DISABLE

[top][index]

@@ -4148,12 +4153,12 @@ IBA Base: Constants/IB_SMINFO_ATTR_MOD_DISABLE

       Encoded attribute modifier value used on SubnSet(SMInfo) SMPs.
 

SOURCE

-
#define IB_SMINFO_ATTR_MOD_DISABLE                      (CL_NTOH32(0x000003))
+
#define IB_SMINFO_ATTR_MOD_DISABLE                      (CL_NTOH32(0x000003))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_ATTR_MOD_DISCOVER

[top][index]

@@ -4164,12 +4169,12 @@ IBA Base: Constants/IB_SMINFO_ATTR_MOD_DISCOVER

       Encoded attribute modifier value used on SubnSet(SMInfo) SMPs.
 

SOURCE

-
#define IB_SMINFO_ATTR_MOD_DISCOVER                     (CL_NTOH32(0x000005))
+
#define IB_SMINFO_ATTR_MOD_DISCOVER                     (CL_NTOH32(0x000005))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_ATTR_MOD_HANDOVER

[top][index]

@@ -4180,12 +4185,12 @@ IBA Base: Constants/IB_SMINFO_ATTR_MOD_HANDOVER

       Encoded attribute modifier value used on SubnSet(SMInfo) SMPs.
 

SOURCE

-
#define IB_SMINFO_ATTR_MOD_HANDOVER             (CL_NTOH32(0x000001))
+
#define IB_SMINFO_ATTR_MOD_HANDOVER             (CL_NTOH32(0x000001))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_ATTR_MOD_STANDBY

[top][index]

@@ -4196,12 +4201,12 @@ IBA Base: Constants/IB_SMINFO_ATTR_MOD_STANDBY

       Encoded attribute modifier value used on SubnSet(SMInfo) SMPs.
 

SOURCE

-
#define IB_SMINFO_ATTR_MOD_STANDBY                      (CL_NTOH32(0x000004))
+
#define IB_SMINFO_ATTR_MOD_STANDBY                      (CL_NTOH32(0x000004))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_STATE_DISCOVERING

[top][index]

@@ -4217,7 +4222,7 @@ IBA Base: Constants/IB_SMINFO_STATE_DISCOVERING


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_STATE_INIT

[top][index]

@@ -4233,7 +4238,7 @@ IBA Base: Constants/IB_SMINFO_STATE_INIT


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_STATE_MASTER

[top][index]

@@ -4249,7 +4254,7 @@ IBA Base: Constants/IB_SMINFO_STATE_MASTER


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_STATE_NOTACTIVE

[top][index]

@@ -4265,7 +4270,7 @@ IBA Base: Constants/IB_SMINFO_STATE_NOTACTIVE


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMINFO_STATE_STANDBY

[top][index]

@@ -4281,7 +4286,7 @@ IBA Base: Constants/IB_SMINFO_STATE_STANDBY


-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMP_DIRECTION

[top][index]

@@ -4292,12 +4297,12 @@ IBA Base: Constants/IB_SMP_DIRECTION

       The Direction bit for directed route SMPs.
 

SOURCE

-
#define IB_SMP_DIRECTION                        (CL_HTON16(0x8000))
+
#define IB_SMP_DIRECTION                        (CL_HTON16(0x8000))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SMP_STATUS_MASK

[top][index]

@@ -4308,12 +4313,12 @@ IBA Base: Constants/IB_SMP_STATUS_MASK

       Mask value for extracting status from a directed route SMP.
 

SOURCE

-
#define IB_SMP_STATUS_MASK                      (CL_HTON16(0x7FFF))
+
#define IB_SMP_STATUS_MASK                      (CL_HTON16(0x7FFF))
 

-

[Definitions] +

[Definitions] IBA Base: Constants/IB_SUBNET_PATH_HOPS_MAX

[top][index]

@@ -4329,7 +4334,7 @@ IBA Base: Constants/IB_SUBNET_PATH_HOPS_MAX


-

[Definitions] +

[Definitions] IBA Base: Constants/Join States

[top][index]

@@ -4347,7 +4352,7 @@ IBA Base: Constants/Join States


-

[Definitions] +

[Definitions] IBA Base: Constants/MAD_BLOCK_GRH_SIZE

[top][index]

@@ -4363,7 +4368,7 @@ IBA Base: Constants/MAD_BLOCK_GRH_SIZE


-

[Definitions] +

[Definitions] IBA Base: Constants/MAD_BLOCK_SIZE

[top][index]

@@ -4379,7 +4384,7 @@ IBA Base: Constants/MAD_BLOCK_SIZE


-

[Definitions] +

[Definitions] IBA Base: Constants/MAD_RMPP_DATA_SIZE

[top][index]

@@ -4390,12 +4395,12 @@ IBA Base: Constants/MAD_RMPP_DATA_SIZE

       Size of an RMPP transaction data section.
 

SOURCE

-
#define MAD_RMPP_DATA_SIZE              (MAD_BLOCK_SIZE - MAD_RMPP_HDR_SIZE)
+
#define MAD_RMPP_DATA_SIZE              (MAD_BLOCK_SIZE - MAD_RMPP_HDR_SIZE)
 

-

[Definitions] +

[Definitions] IBA Base: Constants/MAD_RMPP_HDR_SIZE

[top][index]

@@ -4411,7 +4416,7 @@ IBA Base: Constants/MAD_RMPP_HDR_SIZE


-

[Definitions] +

[Definitions] IBA Base: Types/DM_SVC_NAME

[top][index]

@@ -4428,7 +4433,7 @@ IBA Base: Types/DM_SVC_NAME


-

[Functions] +

[Functions] IBA Base: Types/ib_class_is_vendor_specific

[top][index]

@@ -4443,8 +4448,8 @@ IBA Base: Types/ib_class_is_vendor_specific

ib_class_is_vendor_specific( IN const uint8_t class_code ) { - return( ib_class_is_vendor_specific_low(class_code) || - ib_class_is_vendor_specific_high(class_code) ); + return( ib_class_is_vendor_specific_low(class_code) || + ib_class_is_vendor_specific_high(class_code) ); }

PARAMETERS

@@ -4459,12 +4464,12 @@ IBA Base: Types/ib_class_is_vendor_specific
 

SEE ALSO

-
  ib_class_is_vendor_specific_low, ib_class_is_vendor_specific_high
+
  ib_class_is_vendor_specific_low, ib_class_is_vendor_specific_high
 

-

[Functions] +

[Functions] IBA Base: Types/ib_class_is_vendor_specific_high

[top][index]

@@ -4480,8 +4485,8 @@ IBA Base: Types/ib_class_is_vendor_specific_high

ib_class_is_vendor_specific_high( IN const uint8_t class_code ) { - return( (class_code >= IB_MCLASS_VENDOR_HIGH_RANGE_MIN) && - (class_code <= IB_MCLASS_VENDOR_HIGH_RANGE_MAX)) ; + return( (class_code >= IB_MCLASS_VENDOR_HIGH_RANGE_MIN) && + (class_code <= IB_MCLASS_VENDOR_HIGH_RANGE_MAX)) ; }

PARAMETERS

@@ -4496,12 +4501,12 @@ IBA Base: Types/ib_class_is_vendor_specific_high
 

SEE ALSO

-
 IB_MCLASS_VENDOR_HIGH_RANGE_MIN, IB_MCLASS_VENDOR_HIGH_RANGE_MAX
+
 IB_MCLASS_VENDOR_HIGH_RANGE_MIN, IB_MCLASS_VENDOR_HIGH_RANGE_MAX
 

-

[Functions] +

[Functions] IBA Base: Types/ib_class_is_vendor_specific_low

[top][index]

@@ -4517,8 +4522,8 @@ IBA Base: Types/ib_class_is_vendor_specific_low

ib_class_is_vendor_specific_low( IN const uint8_t class_code ) { - return( (class_code >= IB_MCLASS_VENDOR_LOW_RANGE_MIN) && - (class_code <= IB_MCLASS_VENDOR_LOW_RANGE_MAX)) ; + return( (class_code >= IB_MCLASS_VENDOR_LOW_RANGE_MIN) && + (class_code <= IB_MCLASS_VENDOR_LOW_RANGE_MAX)) ; }

PARAMETERS

@@ -4533,12 +4538,12 @@ IBA Base: Types/ib_class_is_vendor_specific_low
 

SEE ALSO

-
 IB_MCLASS_VENDOR_LOW_RANGE_MIN, IB_MCLASS_VENDOR_LOW_RANGE_MAX
+
 IB_MCLASS_VENDOR_LOW_RANGE_MIN, IB_MCLASS_VENDOR_LOW_RANGE_MAX
 

-

[Structures] +

[Structures] IBA Base: Types/ib_class_port_info_t

[top][index]

@@ -4555,20 +4560,20 @@ typedef struct _ib_class_port_info { uint8_t base_ver; uint8_t class_ver; - ib_net16_t cap_mask; - ib_net32_t resp_time_val; - ib_gid_t redir_gid; - ib_net32_t redir_tc_sl_fl; - ib_net16_t redir_lid; - ib_net16_t redir_pkey; - ib_net32_t redir_qp; - ib_net32_t redir_qkey; - ib_gid_t trap_gid; - ib_net32_t trap_tc_sl_fl; - ib_net16_t trap_lid; - ib_net16_t trap_pkey; - ib_net32_t trap_hop_qp; - ib_net32_t trap_qkey; + ib_net16_t cap_mask; + ib_net32_t resp_time_val; + ib_gid_t redir_gid; + ib_net32_t redir_tc_sl_fl; + ib_net16_t redir_lid; + ib_net16_t redir_pkey; + ib_net32_t redir_qp; + ib_net32_t redir_qkey; + ib_gid_t trap_gid; + ib_net32_t trap_tc_sl_fl; + ib_net16_t trap_lid; + ib_net16_t trap_pkey; + ib_net32_t trap_hop_qp; + ib_net32_t trap_qkey; } PACK_SUFFIX ib_class_port_info_t; #include <complib/cl_packoff.h> @@ -4626,12 +4631,12 @@ typedef struct _ib_class_port_info Q_Key associated with the trap messages QP.

SEE ALSO

-
       IB_CLASS_CAP_GETSET, IB_CLASS_CAP_TRAP
+
       IB_CLASS_CAP_GETSET, IB_CLASS_CAP_TRAP
 

-

[Structures] +

[Structures] IBA Base: Types/ib_dm_mad_t

[top][index]

@@ -4645,7 +4650,7 @@ IBA Base: Types/ib_dm_mad_t

#include <complib/cl_packon.h>
 typedef struct _ib_dm_mad
 {
-        ib_mad_t                hdr;
+        ib_mad_t                hdr;
         uint8_t                 resv[40];
 
 #define IB_DM_DATA_SIZE                 192
@@ -4666,12 +4671,12 @@ typedef struct _ib_dm_mad
                depend upon the method, attr_id, and attr_mod fields in the header.
 

SEE ALSO

-
 ib_mad_t
+
 ib_mad_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_field32_t

[top][index]

@@ -4703,7 +4708,7 @@ typedef union _ib_field32_t
-

[Functions] +

[Functions] IBA Base: Types/ib_get_async_event_str

[top][index]

@@ -4716,7 +4721,7 @@ IBA Base: Types/ib_get_async_event_str

SYNOPSIS

AL_EXPORT const char* AL_API
 ib_get_async_event_str(
-        IN                              ib_async_event_t                        event );
+        IN                              ib_async_event_t                        event );
 

PARAMETERS

       event
@@ -4732,7 +4737,7 @@ IBA Base: Types/ib_get_async_event_str
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_get_err_str

[top][index]

@@ -4761,7 +4766,7 @@ IBA Base: Types/ib_get_err_str


-

[Functions] +

[Functions] IBA Base: Types/ib_get_node_type_str

[top][index]

@@ -4776,7 +4781,7 @@ IBA Base: Types/ib_get_node_type_str

ib_get_node_type_str( IN uint8_t node_type ) { - if( node_type >= IB_NODE_TYPE_ROUTER ) + if( node_type >= IB_NODE_TYPE_ROUTER ) node_type = 0; return( __ib_node_type_str[node_type] ); } @@ -4791,12 +4796,12 @@ IBA Base: Types/ib_get_node_type_str
 

SEE ALSO

-
 ib_node_info_t
+
 ib_node_info_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_get_port_state_from_str

[top][index]

@@ -4828,7 +4833,7 @@ IBA Base: Types/ib_get_port_state_from_str

PARAMETERS

       p_port_state_str
-               [in] A string matching one returned by ib_get_port_state_str
+               [in] A string matching one returned by ib_get_port_state_str
 
  RETURN VALUES
        The appropriate code.
@@ -4837,12 +4842,12 @@ IBA Base: Types/ib_get_port_state_from_str
 
 

SEE ALSO

-
       ib_port_info_t
+
       ib_port_info_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_get_port_state_str

[top][index]

@@ -4872,12 +4877,12 @@ IBA Base: Types/ib_get_port_state_str

 

SEE ALSO

-
 ib_port_info_t
+
 ib_port_info_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_get_wc_status_str

[top][index]

@@ -4906,7 +4911,7 @@ IBA Base: Types/ib_get_wc_status_str


-

[Functions] +

[Functions] IBA Base: Types/ib_get_wc_type_str

[top][index]

@@ -4935,7 +4940,7 @@ IBA Base: Types/ib_get_wc_type_str


-

[Functions] +

[Functions] IBA Base: Types/ib_get_wr_type_str

[top][index]

@@ -4965,7 +4970,7 @@ IBA Base: Types/ib_get_wr_type_str


-

[Functions] +

[Functions] IBA Base: Types/ib_gid_get_guid

[top][index]

@@ -4976,9 +4981,9 @@ IBA Base: Types/ib_gid_get_guid

       Gets the guid from a GID.
 

SYNOPSIS

-
AL_INLINE ib_net64_t AL_API
+
AL_INLINE ib_net64_t AL_API
 ib_gid_get_guid(
-        IN              const   ib_gid_t* const                         p_gid )
+        IN              const   ib_gid_t* const                         p_gid )
 {
         return( p_gid->unicast.interface_id );
 }
@@ -4994,12 +4999,12 @@ IBA Base: Types/ib_gid_get_guid
 
 

SEE ALSO

-
       ib_gid_t
+
       ib_gid_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_gid_get_subnet_prefix

[top][index]

@@ -5010,9 +5015,9 @@ IBA Base: Types/ib_gid_get_subnet_prefix

       Gets the subnet prefix from a GID.
 

SYNOPSIS

-
AL_INLINE ib_net64_t AL_API
+
AL_INLINE ib_net64_t AL_API
 ib_gid_get_subnet_prefix(
-        IN              const   ib_gid_t* const                         p_gid )
+        IN              const   ib_gid_t* const                         p_gid )
 {
         return( p_gid->unicast.prefix );
 }
@@ -5028,12 +5033,12 @@ IBA Base: Types/ib_gid_get_subnet_prefix
 
 

SEE ALSO

-
       ib_gid_t
+
       ib_gid_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_gid_is_link_local

[top][index]

@@ -5047,9 +5052,9 @@ IBA Base: Types/ib_gid_is_link_local

SYNOPSIS

static inline boolean_t
 ib_gid_is_link_local(
-        IN              const   ib_gid_t* const                         p_gid )
+        IN              const   ib_gid_t* const                         p_gid )
 {
-        return( ib_gid_get_subnet_prefix( p_gid ) == IB_DEFAULT_SUBNET_PREFIX );
+        return( ib_gid_get_subnet_prefix( p_gid ) == IB_DEFAULT_SUBNET_PREFIX );
 }
 

PARAMETERS

@@ -5064,12 +5069,12 @@ IBA Base: Types/ib_gid_is_link_local
 

SEE ALSO

-
       ib_gid_t
+
       ib_gid_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_gid_is_site_local

[top][index]

@@ -5083,11 +5088,11 @@ IBA Base: Types/ib_gid_is_site_local

SYNOPSIS

static inline boolean_t
 ib_gid_is_site_local(
-        IN              const   ib_gid_t* const                         p_gid )
+        IN              const   ib_gid_t* const                         p_gid )
 {
-        return( ( ib_gid_get_subnet_prefix( p_gid ) &
-                CL_HTON64( CL_CONST64(0xFFFFFFFFFFFF0000) ) ) ==
-                CL_HTON64( CL_CONST64(0xFEC0000000000000) ) );
+        return( ( ib_gid_get_subnet_prefix( p_gid ) &
+                CL_HTON64( CL_CONST64(0xFFFFFFFFFFFF0000) ) ) ==
+                CL_HTON64( CL_CONST64(0xFEC0000000000000) ) );
 }
 

PARAMETERS

@@ -5102,12 +5107,12 @@ IBA Base: Types/ib_gid_is_site_local
 

SEE ALSO

-
       ib_gid_t
+
       ib_gid_t
 

-

[Definitions] +

[Definitions] IBA Base: Types/ib_gid_prefix_t

[top][index]

@@ -5118,12 +5123,12 @@ IBA Base: Types/ib_gid_prefix_t

 

SOURCE

-
typedef ib_net64_t              ib_gid_prefix_t;
+
typedef ib_net64_t              ib_gid_prefix_t;
 

-

[Functions] +

[Functions] IBA Base: Types/ib_gid_set_default

[top][index]

@@ -5136,10 +5141,10 @@ IBA Base: Types/ib_gid_set_default

SYNOPSIS

AL_INLINE void AL_API
 ib_gid_set_default(
-        IN                              ib_gid_t* const                         p_gid,
-        IN              const   ib_net64_t                                      interface_id )
+        IN                              ib_gid_t* const                         p_gid,
+        IN              const   ib_net64_t                                      interface_id )
 {
-        p_gid->unicast.prefix = IB_DEFAULT_SUBNET_PREFIX;
+        p_gid->unicast.prefix = IB_DEFAULT_SUBNET_PREFIX;
         p_gid->unicast.interface_id = interface_id;
 }
 
@@ -5157,12 +5162,12 @@ IBA Base: Types/ib_gid_set_default
 

SEE ALSO

-
       ib_gid_t
+
       ib_gid_t
 

-

[Definitions] +

[Definitions] IBA Base: Types/ib_gid_t

[top][index]

@@ -5179,8 +5184,8 @@ typedef union _ib_gid uint8_t raw[16]; struct _ib_gid_unicast { - ib_gid_prefix_t prefix; - ib_net64_t interface_id; + ib_gid_prefix_t prefix; + ib_net64_t interface_id; } PACK_SUFFIX unicast; @@ -5209,7 +5214,7 @@ typedef union _ib_gid
-

[Structures] +

[Structures] IBA Base: Types/ib_gmp_t

[top][index]

@@ -5229,12 +5234,12 @@ typedef struct _ib_gmp uint8_t mgmt_class; uint8_t class_ver; uint8_t method; - ib_net16_t status; - ib_net16_t resv; - ib_net64_t trans_id; - ib_net16_t attr_id; - ib_net16_t resv1; - ib_net32_t attr_mod; + ib_net16_t status; + ib_net16_t resv; + ib_net64_t trans_id; + ib_net16_t attr_id; + ib_net16_t resv1; + ib_net32_t attr_mod; uint8_t resv2[40]; uint8_t data[IB_GMP_DATA_SIZE]; @@ -5244,7 +5249,7 @@ typedef struct _ib_gmp
-

[Functions] +

[Functions] IBA Base: Types/ib_grh_get_ver_class_flow

[top][index]

@@ -5257,14 +5262,14 @@ IBA Base: Types/ib_grh_get_ver_class_flow

SYNOPSIS

AL_INLINE void AL_API
 ib_grh_get_ver_class_flow(
-        IN              const   ib_net32_t                                      ver_class_flow,
+        IN              const   ib_net32_t                                      ver_class_flow,
                 OUT                     uint8_t* const                          p_ver OPTIONAL,
                 OUT                     uint8_t* const                          p_tclass OPTIONAL,
                 OUT                     net32_t* const                          p_flow_lbl OPTIONAL )
 {
-        ib_net32_t tmp_ver_class_flow;
+        ib_net32_t tmp_ver_class_flow;
 
-        tmp_ver_class_flow = cl_ntoh32( ver_class_flow );
+        tmp_ver_class_flow = cl_ntoh32( ver_class_flow );
 
         if (p_ver)
                 *p_ver = (uint8_t)(tmp_ver_class_flow >> 28);
@@ -5273,7 +5278,7 @@ IBA Base: Types/ib_grh_get_ver_class_flow
                 *p_tclass = (uint8_t)(tmp_ver_class_flow >> 20);
 
         if (p_flow_lbl)
-                *p_flow_lbl = (ver_class_flow & CL_HTON32( 0x000FFFFF ));
+                *p_flow_lbl = (ver_class_flow & CL_HTON32( 0x000FFFFF ));
 }
 

PARAMETERS

@@ -5294,12 +5299,12 @@ IBA Base: Types/ib_grh_get_ver_class_flow
 

SEE ALSO

-
       ib_grh_t
+
       ib_grh_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_grh_set_ver_class_flow

[top][index]

@@ -5310,16 +5315,16 @@ IBA Base: Types/ib_grh_set_ver_class_flow

       Set encoded version, traffic class and flow label in grh
 

SYNOPSIS

-
AL_INLINE ib_net32_t AL_API
+
AL_INLINE ib_net32_t AL_API
 ib_grh_set_ver_class_flow(
         IN              const   uint8_t                                         ver,
         IN              const   uint8_t                                         tclass,
         IN              const   net32_t                                         flow_lbl )
 {
-        ib_net32_t              ver_class_flow;
+        ib_net32_t              ver_class_flow;
 
-        ver_class_flow = cl_hton32( (ver << 28) | (tclass << 20) );
-        ver_class_flow |= (flow_lbl & CL_HTON32( 0x000FFFFF ));
+        ver_class_flow = cl_hton32( (ver << 28) | (tclass << 20) );
+        ver_class_flow |= (flow_lbl & CL_HTON32( 0x000FFFFF ));
         return (ver_class_flow);
 }
 
@@ -5341,12 +5346,12 @@ IBA Base: Types/ib_grh_set_ver_class_flow
 

SEE ALSO

-
       ib_grh_t
+
       ib_grh_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_grh_t

[top][index]

@@ -5360,12 +5365,12 @@ IBA Base: Types/ib_grh_t

#include <complib/cl_packon.h>
 typedef struct _ib_grh
 {
-        ib_net32_t                              ver_class_flow;
-        ib_net16_t                              resv1;
+        ib_net32_t                              ver_class_flow;
+        ib_net16_t                              resv1;
         uint8_t                                 resv2;
         uint8_t                                 hop_limit;
-        ib_gid_t                                src_gid;
-        ib_gid_t                                dest_gid;
+        ib_gid_t                                src_gid;
+        ib_gid_t                                dest_gid;
 
 }       PACK_SUFFIX ib_grh_t;
 #include <complib/cl_packoff.h>
@@ -5373,7 +5378,7 @@ typedef struct _ib_grh
 
 
-

[Structures] +

[Structures] IBA Base: Types/ib_guid_info_t

[top][index]

@@ -5389,7 +5394,7 @@ IBA Base: Types/ib_guid_info_t

#include <complib/cl_packon.h> typedef struct _ib_guid_info { - ib_net64_t guid[GUID_TABLE_MAX_ENTRIES]; + ib_net64_t guid[GUID_TABLE_MAX_ENTRIES]; } PACK_SUFFIX ib_guid_info_t; #include <complib/cl_packoff.h> @@ -5397,7 +5402,7 @@ typedef struct _ib_guid_info
-

[Functions] +

[Functions] IBA Base: Types/ib_inform_get_dev_id

[top][index]

@@ -5412,7 +5417,7 @@ IBA Base: Types/ib_inform_get_dev_id

ib_inform_get_dev_id( IN const ib_inform_info_t* const p_inform_info ) { - return ib_inform_get_trap_num( p_inform_info ); + return ib_inform_get_trap_num( p_inform_info ); }

PARAMETERS

@@ -5424,12 +5429,12 @@ IBA Base: Types/ib_inform_get_dev_id Returns the vendor ID of the inform info, in host byte order.

SEE ALSO

-
       ib_inform_info_t, ib_inform_set_dev_id
+
       ib_inform_info_t, ib_inform_set_dev_id
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_get_prod_type

[top][index]

@@ -5444,7 +5449,7 @@ IBA Base: Types/ib_inform_get_prod_type

ib_inform_get_prod_type( IN const ib_inform_info_t* const p_inform_info ) { - return (cl_ntoh32( p_inform_info->combo3 ) >> 8); + return (cl_ntoh32( p_inform_info->combo3 ) >> 8); }

PARAMETERS

@@ -5456,12 +5461,12 @@ IBA Base: Types/ib_inform_get_prod_type Returns the producer type of the infrom info, in host byte order.

SEE ALSO

-
       ib_inform_info_t, ib_inform_set_prod_type
+
       ib_inform_info_t, ib_inform_set_prod_type
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_get_qpn

[top][index]

@@ -5476,7 +5481,7 @@ IBA Base: Types/ib_inform_get_qpn

ib_inform_get_qpn( IN const ib_inform_info_t* const p_inform_info ) { - return (p_inform_info->combo2 & CL_NTOH32( 0x00FFFFFF )); + return (p_inform_info->combo2 & CL_NTOH32( 0x00FFFFFF )); }

PARAMETERS

@@ -5488,12 +5493,12 @@ IBA Base: Types/ib_inform_get_qpn Returns the QPN of the infrom info.

SEE ALSO

-
       ib_inform_info_t, ib_inform_set_qpn
+
       ib_inform_info_t, ib_inform_set_qpn
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_get_resp_time_val

[top][index]

@@ -5508,7 +5513,7 @@ IBA Base: Types/ib_inform_get_resp_time_val

ib_inform_get_resp_time_val( IN const ib_inform_info_t* const p_inform_info ) { - return (uint8_t)(cl_ntoh32( p_inform_info->combo2 ) >> 27); + return (uint8_t)(cl_ntoh32( p_inform_info->combo2 ) >> 27); }

PARAMETERS

@@ -5520,12 +5525,12 @@ IBA Base: Types/ib_inform_get_resp_time_val Returns the response time value of the infrom info.

SEE ALSO

-
       ib_inform_info_t, ib_inform_set_resp_time_val
+
       ib_inform_info_t, ib_inform_set_resp_time_val
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_get_trap_num

[top][index]

@@ -5540,7 +5545,7 @@ IBA Base: Types/ib_inform_get_trap_num

ib_inform_get_trap_num( IN const ib_inform_info_t* const p_inform_info ) { - return cl_ntoh16( p_inform_info->combo1 ); + return cl_ntoh16( p_inform_info->combo1 ); }

PARAMETERS

@@ -5552,12 +5557,12 @@ IBA Base: Types/ib_inform_get_trap_num Returns the trap number of the infrom info, in host byte order.

SEE ALSO

-
       ib_inform_info_t, ib_inform_set_trap_num
+
       ib_inform_info_t, ib_inform_set_trap_num
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_get_vend_id

[top][index]

@@ -5572,7 +5577,7 @@ IBA Base: Types/ib_inform_get_vend_id

ib_inform_get_vend_id( IN const ib_inform_info_t* const p_inform_info ) { - return ib_inform_get_prod_type( p_inform_info ); + return ib_inform_get_prod_type( p_inform_info ); }

PARAMETERS

@@ -5584,12 +5589,12 @@ IBA Base: Types/ib_inform_get_vend_id Returns the vendor ID of the infrom info, in host byte order.

SEE ALSO

-
       ib_inform_info_t, ib_inform_set_vend_id
+
       ib_inform_info_t, ib_inform_set_vend_id
 

-

[Structures] +

[Structures] IBA Base: Types/ib_inform_info_record_t

[top][index]

@@ -5603,7 +5608,7 @@ IBA Base: Types/ib_inform_info_record_t

#include <complib/cl_packon.h>
 typedef struct _ib_inform_info_record
 {
-        ib_gid_t                                subscriber_gid;
+        ib_gid_t                                subscriber_gid;
         net16_t                                 subscriber_enum;
         uint16_t                                reserved[3];
         ib_inform_info_t                inform_info;
@@ -5614,7 +5619,7 @@ typedef struct _ib_inform_info_record
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_inform_set_dev_id

[top][index]

@@ -5630,7 +5635,7 @@ IBA Base: Types/ib_inform_set_dev_id

IN OUT ib_inform_info_t* const p_inform_info, IN const uint16_t dev_id ) { - ib_inform_set_trap_num( p_inform_info, dev_id ); + ib_inform_set_trap_num( p_inform_info, dev_id ); }

PARAMETERS

@@ -5645,12 +5650,12 @@ IBA Base: Types/ib_inform_set_dev_id This function does not return a value.

SEE ALSO

-
       ib_inform_info_t, ib_inform_get_dev_id
+
       ib_inform_info_t, ib_inform_get_dev_id
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_set_prod_type

[top][index]

@@ -5666,7 +5671,7 @@ IBA Base: Types/ib_inform_set_prod_type

IN OUT ib_inform_info_t* const p_inform_info, IN const uint32_t prod_type ) { - p_inform_info->combo3 = cl_hton32( prod_type << 8 ); + p_inform_info->combo3 = cl_hton32( prod_type << 8 ); }

PARAMETERS

@@ -5681,12 +5686,12 @@ IBA Base: Types/ib_inform_set_prod_type This function does not return a value.

SEE ALSO

-
       ib_inform_info_t, ib_inform_get_prod_type
+
       ib_inform_info_t, ib_inform_get_prod_type
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_set_qpn

[top][index]

@@ -5702,8 +5707,8 @@ IBA Base: Types/ib_inform_set_qpn

IN OUT ib_inform_info_t* const p_inform_info, IN const net32_t qpn ) { - p_inform_info->combo2 &= CL_NTOH32( 0xFF000000 ); - p_inform_info->combo2 |= (qpn & CL_NTOH32( 0x00FFFFFF )); + p_inform_info->combo2 &= CL_NTOH32( 0xFF000000 ); + p_inform_info->combo2 |= (qpn & CL_NTOH32( 0x00FFFFFF )); }

PARAMETERS

@@ -5718,12 +5723,12 @@ IBA Base: Types/ib_inform_set_qpn This function does not return a value.

SEE ALSO

-
       ib_inform_info_t, ib_inform_get_qpn
+
       ib_inform_info_t, ib_inform_get_qpn
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_set_resp_time_val

[top][index]

@@ -5741,10 +5746,10 @@ IBA Base: Types/ib_inform_set_resp_time_val

{ uint32_t val; - val = cl_ntoh32( p_inform_info->combo2 ); + val = cl_ntoh32( p_inform_info->combo2 ); val &= 0x07FFFFFF; val |= (resp_time_val << 27); - p_inform_info->combo2 = cl_hton32( val ); + p_inform_info->combo2 = cl_hton32( val ); }

PARAMETERS

@@ -5759,12 +5764,12 @@ IBA Base: Types/ib_inform_set_resp_time_val This function does not return a value.

SEE ALSO

-
       ib_inform_info_t, ib_inform_get_resp_time_val
+
       ib_inform_info_t, ib_inform_get_resp_time_val
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_set_trap_num

[top][index]

@@ -5780,7 +5785,7 @@ IBA Base: Types/ib_inform_set_trap_num

IN OUT ib_inform_info_t* const p_inform_info, IN const uint16_t trap_num ) { - p_inform_info->combo1 = cl_hton16( trap_num ); + p_inform_info->combo1 = cl_hton16( trap_num ); }

PARAMETERS

@@ -5795,12 +5800,12 @@ IBA Base: Types/ib_inform_set_trap_num This function does not return a value.

SEE ALSO

-
       ib_inform_info_t, ib_inform_get_trap_num
+
       ib_inform_info_t, ib_inform_get_trap_num
 

-

[Functions] +

[Functions] IBA Base: Types/ib_inform_set_vend_id

[top][index]

@@ -5816,7 +5821,7 @@ IBA Base: Types/ib_inform_set_vend_id

IN OUT ib_inform_info_t* const p_inform_info, IN const uint32_t vend_id ) { - ib_inform_set_prod_type( p_inform_info, vend_id ); + ib_inform_set_prod_type( p_inform_info, vend_id ); }

PARAMETERS

@@ -5831,12 +5836,12 @@ IBA Base: Types/ib_inform_set_vend_id This function does not return a value.

SEE ALSO

-
       ib_mad_inform_info_t, ib_inform_get_vend_id
+
       ib_mad_inform_info_t, ib_inform_get_vend_id
 

-

[Structures] +

[Structures] IBA Base: Types/ib_ioc_profile_t

[top][index]

@@ -5850,28 +5855,28 @@ IBA Base: Types/ib_ioc_profile_t

#include <complib/cl_packon.h>
 typedef __declspec(align(8)) struct _ib_ioc_profile
 {
-        ib_net64_t                              ioc_guid;
+        ib_net64_t                              ioc_guid;
 
-        ib_net32_t                              vend_id;
+        ib_net32_t                              vend_id;
 
-        ib_net32_t                              dev_id;
-        ib_net16_t                              dev_ver;
-        ib_net16_t                              resv2;
+        ib_net32_t                              dev_id;
+        ib_net16_t                              dev_ver;
+        ib_net16_t                              resv2;
 
-        ib_net32_t                              subsys_vend_id;
-        ib_net32_t                              subsys_id;
+        ib_net32_t                              subsys_vend_id;
+        ib_net32_t                              subsys_id;
 
-        ib_net16_t                              io_class;
-        ib_net16_t                              io_subclass;
-        ib_net16_t                              protocol;
-        ib_net16_t                              protocol_ver;
+        ib_net16_t                              io_class;
+        ib_net16_t                              io_subclass;
+        ib_net16_t                              protocol;
+        ib_net16_t                              protocol_ver;
 
-        ib_net32_t                              resv3;
-        ib_net16_t                              send_msg_depth;
+        ib_net32_t                              resv3;
+        ib_net16_t                              send_msg_depth;
         uint8_t                                 resv4;
         uint8_t                                 rdma_read_depth;
-        ib_net32_t                              send_msg_size;
-        ib_net32_t                              rdma_size;
+        ib_net32_t                              send_msg_size;
+        ib_net32_t                              rdma_size;
 
         uint8_t                                 ctrl_ops_cap;
 #define CTRL_OPS_CAP_ST         0x01
@@ -5953,12 +5958,12 @@ typedef __declspec(align(8)) struct _ib_ioc_profile
                UTF-8 encoded string for identifying the controller to an operator.
 

SEE ALSO

-
 ib_dm_mad_t
+
 ib_dm_mad_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_iou_info_diag_dev_id

[top][index]

@@ -5971,7 +5976,7 @@ IBA Base: Types/ib_iou_info_diag_dev_id

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_iou_info_diag_dev_id(
-        IN              const   ib_iou_info_t* const            p_iou_info )
+        IN              const   ib_iou_info_t* const            p_iou_info )
 {
         return( (uint8_t)(p_iou_info->diag_rom >> 6 & 1) );
 }
@@ -5987,12 +5992,12 @@ IBA Base: Types/ib_iou_info_diag_dev_id
 
 

SEE ALSO

-
       ib_iou_info_t
+
       ib_iou_info_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_iou_info_option_rom

[top][index]

@@ -6005,7 +6010,7 @@ IBA Base: Types/ib_iou_info_option_rom

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_iou_info_option_rom(
-        IN              const   ib_iou_info_t*  const   p_iou_info )
+        IN              const   ib_iou_info_t*  const   p_iou_info )
 {
         return( (uint8_t)(p_iou_info->diag_rom >> 7) );
 }
@@ -6021,12 +6026,12 @@ IBA Base: Types/ib_iou_info_option_rom
 
 

SEE ALSO

-
       ib_iou_info_t
+
       ib_iou_info_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_iou_info_t

[top][index]

@@ -6040,7 +6045,7 @@ IBA Base: Types/ib_iou_info_t

#include <complib/cl_packon.h>
 typedef struct _ib_iou_info
 {
-        ib_net16_t              change_id;
+        ib_net16_t              change_id;
         uint8_t                 max_controllers;
         uint8_t                 diag_rom;
 
@@ -6065,21 +6070,21 @@ typedef struct _ib_iou_info
 
        diag_rom
                A byte containing two fields: DiagDeviceID and OptionROM.
-               These fields may be read using the ib_iou_info_diag_dev_id
-               and ib_iou_info_option_rom functions.
+               These fields may be read using the ib_iou_info_diag_dev_id
+               and ib_iou_info_option_rom functions.
 
        controller_list
                A series of 4-bit nibbles, with each nibble representing a slot
                in the IO Unit.  Individual nibbles may be read using the
-               ioc_at_slot function.
+               ioc_at_slot function.
 

SEE ALSO

-
 ib_dm_mad_t, ib_iou_info_diag_dev_id, ib_iou_info_option_rom, ioc_at_slot
+
 ib_dm_mad_t, ib_iou_info_diag_dev_id, ib_iou_info_option_rom, ioc_at_slot
 

-

[Structures] +

[Structures] IBA Base: Types/ib_lft_record_t

[top][index]

@@ -6093,8 +6098,8 @@ IBA Base: Types/ib_lft_record_t

#include <complib/cl_packon.h>
 typedef struct _ib_lft_record
 {
-        ib_net16_t              lid;
-        ib_net16_t              block_num;
+        ib_net16_t              lid;
+        ib_net16_t              block_num;
         uint32_t                resv0;
         uint8_t                 lft[64];
 
@@ -6104,7 +6109,7 @@ typedef struct _ib_lft_record
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_mad_init_new

[top][index]

@@ -6117,13 +6122,13 @@ IBA Base: Types/ib_mad_init_new

SYNOPSIS

AL_INLINE void AL_API
 ib_mad_init_new(
-        IN                              ib_mad_t* const                         p_mad,
+        IN                              ib_mad_t* const                         p_mad,
         IN              const   uint8_t                                         mgmt_class,
         IN              const   uint8_t                                         class_ver,
         IN              const   uint8_t                                         method,
-        IN              const   ib_net64_t                                      trans_id,
-        IN              const   ib_net16_t                                      attr_id,
-        IN              const   ib_net32_t                                      attr_mod )
+        IN              const   ib_net64_t                                      trans_id,
+        IN              const   ib_net16_t                                      attr_id,
+        IN              const   ib_net32_t                                      attr_mod )
 {
         CL_ASSERT( p_mad );
         p_mad->base_ver = 1;
@@ -6167,12 +6172,12 @@ IBA Base: Types/ib_mad_init_new
 
 

SEE ALSO

-
       ib_mad_t
+
       ib_mad_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_mad_init_response

[top][index]

@@ -6185,17 +6190,17 @@ IBA Base: Types/ib_mad_init_response

SYNOPSIS

AL_INLINE void AL_API
 ib_mad_init_response(
-        IN              const   ib_mad_t* const                         p_req_mad,
-        IN                              ib_mad_t* const                         p_mad,
-        IN              const   ib_net16_t                                      status )
+        IN              const   ib_mad_t* const                         p_req_mad,
+        IN                              ib_mad_t* const                         p_mad,
+        IN              const   ib_net16_t                                      status )
 {
         CL_ASSERT( p_req_mad );
         CL_ASSERT( p_mad );
         *p_mad = *p_req_mad;
         p_mad->status = status;
-        if( p_mad->method == IB_MAD_METHOD_SET )
-                p_mad->method = IB_MAD_METHOD_GET;
-        p_mad->method |= IB_MAD_METHOD_RESP_MASK;
+        if( p_mad->method == IB_MAD_METHOD_SET )
+                p_mad->method = IB_MAD_METHOD_GET;
+        p_mad->method |= IB_MAD_METHOD_RESP_MASK;
 }
 

PARAMETERS

@@ -6215,12 +6220,12 @@ IBA Base: Types/ib_mad_init_response
       p_req_mad and p_mad may point to the same MAD.
 

SEE ALSO

-
       ib_mad_t
+
       ib_mad_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_mad_is_response

[top][index]

@@ -6234,11 +6239,11 @@ IBA Base: Types/ib_mad_is_response

SYNOPSIS

AL_INLINE boolean_t AL_API
 ib_mad_is_response(
-        IN              const   ib_mad_t* const                         p_mad )
+        IN              const   ib_mad_t* const                         p_mad )
 {
         CL_ASSERT( p_mad );
-        return( (p_mad->method & IB_MAD_METHOD_RESP_MASK) ==
-                        IB_MAD_METHOD_RESP_MASK );
+        return( (p_mad->method & IB_MAD_METHOD_RESP_MASK) ==
+                        IB_MAD_METHOD_RESP_MASK );
 }
 

PARAMETERS

@@ -6253,12 +6258,12 @@ IBA Base: Types/ib_mad_is_response
 

SEE ALSO

-
       ib_mad_t
+
       ib_mad_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_mad_t

[top][index]

@@ -6276,12 +6281,12 @@ typedef struct _ib_mad uint8_t mgmt_class; uint8_t class_ver; uint8_t method; - ib_net16_t status; - ib_net16_t class_spec; - ib_net64_t trans_id; - ib_net16_t attr_id; - ib_net16_t resv; - ib_net32_t attr_mod; + ib_net16_t status; + ib_net16_t class_spec; + ib_net64_t trans_id; + ib_net16_t attr_id; + ib_net16_t resv; + ib_net32_t attr_mod; } PACK_SUFFIX ib_mad_t; #include <complib/cl_packoff.h> @@ -6321,7 +6326,7 @@ typedef struct _ib_mad
-

[Functions] +

[Functions] IBA Base: Types/ib_member_get_scope

[top][index]

@@ -6347,12 +6352,12 @@ IBA Base: Types/ib_member_get_scope

Encoded scope.

SEE ALSO

-
       ib_member_rec_t
+
       ib_member_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_member_get_scope_state

[top][index]

@@ -6370,10 +6375,10 @@ IBA Base: Types/ib_member_get_scope_state

OUT uint8_t* const p_state ) { if (p_scope) - *p_scope = ib_member_get_scope( scope_state ); + *p_scope = ib_member_get_scope( scope_state ); if (p_state) - *p_state = ib_member_get_state( scope_state ); + *p_state = ib_member_get_state( scope_state ); }

PARAMETERS

@@ -6391,12 +6396,12 @@ IBA Base: Types/ib_member_get_scope_state
 

SEE ALSO

-
       ib_member_rec_t
+
       ib_member_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_member_get_sl_flow_hop

[top][index]

@@ -6409,12 +6414,12 @@ IBA Base: Types/ib_member_get_sl_flow_hop

SYNOPSIS

AL_INLINE void AL_API
 ib_member_get_sl_flow_hop(
-        IN              const   ib_net32_t                                      sl_flow_hop,
+        IN              const   ib_net32_t                                      sl_flow_hop,
                 OUT                     uint8_t* const                          p_sl OPTIONAL,
                 OUT                     net32_t* const                          p_flow_lbl OPTIONAL,
                 OUT                     uint8_t* const                          p_hop OPTIONAL )
 {
-        ib_net32_t tmp_sl_flow_hop;
+        ib_net32_t tmp_sl_flow_hop;
 
         if (p_sl)
                 *p_sl = (uint8_t)(sl_flow_hop & 0x0f);
@@ -6448,12 +6453,12 @@ IBA Base: Types/ib_member_get_sl_flow_hop
 
 

SEE ALSO

-
       ib_member_rec_t
+
       ib_member_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_member_get_state

[top][index]

@@ -6479,12 +6484,12 @@ IBA Base: Types/ib_member_get_state

Encoded JoinState

SEE ALSO

-
       ib_member_rec_t
+
       ib_member_rec_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_member_rec_t

[top][index]

@@ -6499,16 +6504,16 @@ IBA Base: Types/ib_member_rec_t

#include <complib/cl_packon.h>
 typedef struct _ib_member_rec
 {
-        ib_gid_t                                mgid;
-        ib_gid_t                                port_gid;
-        ib_net32_t                              qkey;
-        ib_net16_t                              mlid;
+        ib_gid_t                                mgid;
+        ib_gid_t                                port_gid;
+        ib_net32_t                              qkey;
+        ib_net16_t                              mlid;
         uint8_t                                 mtu;
         uint8_t                                 tclass;
-        ib_net16_t                              pkey;
+        ib_net16_t                              pkey;
         uint8_t                                 rate;
         uint8_t                                 pkt_life;
-        ib_net32_t                              sl_flow_hop;
+        ib_net32_t                              sl_flow_hop;
         uint8_t                                 scope_state;
         uint8_t                                 proxy_join;
         uint8_t                                 reserved[2];
@@ -6561,7 +6566,7 @@ typedef struct _ib_member_rec
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_member_set_join_state

[top][index]

@@ -6574,7 +6579,7 @@ IBA Base: Types/ib_member_set_join_state

SYNOPSIS

AL_INLINE void AL_API
 ib_member_set_join_state(
-        IN      OUT                     ib_member_rec_t                         *p_mc_rec,
+        IN      OUT                     ib_member_rec_t                         *p_mc_rec,
         IN              const   uint8_t                                         state )
 {
         p_mc_rec->scope_state &= 0xF0;
@@ -6595,12 +6600,12 @@ IBA Base: Types/ib_member_set_join_state
 
 

SEE ALSO

-
       ib_member_rec_t
+
       ib_member_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_member_set_scope

[top][index]

@@ -6633,12 +6638,12 @@ IBA Base: Types/ib_member_set_scope

This function does not return a value.

SEE ALSO

-
       ib_member_rec_t
+
       ib_member_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_member_set_scope_state

[top][index]

@@ -6673,12 +6678,12 @@ IBA Base: Types/ib_member_set_scope_state

 

SEE ALSO

-
       ib_member_rec_t
+
       ib_member_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_member_set_sl_flow_hop

[top][index]

@@ -6689,20 +6694,20 @@ IBA Base: Types/ib_member_set_sl_flow_hop

       Set encoded version, sl flow and hop
 

SYNOPSIS

-
AL_INLINE ib_net32_t AL_API
+
AL_INLINE ib_net32_t AL_API
 ib_member_set_sl_flow_hop(
         IN              const   uint8_t                                         sl,
         IN              const   net32_t                                         flow_lbl,
         IN              const   uint8_t                                         hop_limit )
 {
-        ib_net32_t              sl_flow_hop;
+        ib_net32_t              sl_flow_hop;
 
         sl_flow_hop = sl;
         sl_flow_hop <<= 20;
-        sl_flow_hop |= (cl_ntoh32( flow_lbl ) & 0x000FFFFF);
+        sl_flow_hop |= (cl_ntoh32( flow_lbl ) & 0x000FFFFF);
         sl_flow_hop <<= 8;
         sl_flow_hop |= hop_limit;
-        return cl_hton32(sl_flow_hop);
+        return cl_hton32(sl_flow_hop);
 }
 

PARAMETERS

@@ -6723,12 +6728,12 @@ IBA Base: Types/ib_member_set_sl_flow_hop
 

SEE ALSO

-
       ib_member_rec_t
+
       ib_member_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_member_set_state

[top][index]

@@ -6761,12 +6766,12 @@ IBA Base: Types/ib_member_set_state

This function does not return a value.

SEE ALSO

-
       ib_member_rec_t
+
       ib_member_rec_t
 

-

[Definitions] +

[Definitions] IBA Base: Types/ib_net16_t

[top][index]

@@ -6782,7 +6787,7 @@ IBA Base: Types/ib_net16_t


-

[Definitions] +

[Definitions] IBA Base: Types/ib_net32_t

[top][index]

@@ -6798,7 +6803,7 @@ IBA Base: Types/ib_net32_t


-

[Definitions] +

[Definitions] IBA Base: Types/ib_net64_t

[top][index]

@@ -6814,7 +6819,7 @@ IBA Base: Types/ib_net64_t


-

[Functions] +

[Functions] IBA Base: Types/ib_node_info_get_local_port_num

[top][index]

@@ -6827,7 +6832,7 @@ IBA Base: Types/ib_node_info_get_local_port_num

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_node_info_get_local_port_num(
-        IN              const   ib_node_info_t* const           p_ni )
+        IN              const   ib_node_info_t* const           p_ni )
 {
         return( (uint8_t)(( p_ni->port_num_vendor_id &
                         IB_NODE_INFO_PORT_NUM_MASK )
@@ -6845,12 +6850,12 @@ IBA Base: Types/ib_node_info_get_local_port_num
 
 

SEE ALSO

-
       ib_node_info_t
+
       ib_node_info_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_node_info_get_vendor_id

[top][index]

@@ -6861,11 +6866,11 @@ IBA Base: Types/ib_node_info_get_vendor_id

       Gets the VendorID from the NodeInfo attribute.
 

SYNOPSIS

-
AL_INLINE ib_net32_t AL_API
+
AL_INLINE ib_net32_t AL_API
 ib_node_info_get_vendor_id(
-        IN              const   ib_node_info_t* const           p_ni )
+        IN              const   ib_node_info_t* const           p_ni )
 {
-        return( (ib_net32_t)( p_ni->port_num_vendor_id &
+        return( (ib_net32_t)( p_ni->port_num_vendor_id &
                         IB_NODE_INFO_VEND_ID_MASK ) );
 }
 
@@ -6880,12 +6885,12 @@ IBA Base: Types/ib_node_info_get_vendor_id
 

SEE ALSO

-
       ib_node_info_t
+
       ib_node_info_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_node_info_t

[top][index]

@@ -6903,13 +6908,13 @@ typedef struct _ib_node_info uint8_t class_version; uint8_t node_type; uint8_t num_ports; - ib_net64_t sys_guid; - ib_net64_t node_guid; - ib_net64_t port_guid; - ib_net16_t partition_cap; - ib_net16_t device_id; - ib_net32_t revision; - ib_net32_t port_num_vendor_id; + ib_net64_t sys_guid; + ib_net64_t node_guid; + ib_net64_t port_guid; + ib_net16_t partition_cap; + ib_net16_t device_id; + ib_net32_t revision; + ib_net32_t port_num_vendor_id; } PACK_SUFFIX ib_node_info_t; #include <complib/cl_packoff.h> @@ -6917,7 +6922,7 @@ typedef struct _ib_node_info
-

[Functions] +

[Functions] IBA Base: Types/ib_notice_get_count

[top][index]

@@ -6932,7 +6937,7 @@ IBA Base: Types/ib_notice_get_count

ib_notice_get_count( IN const ib_mad_notice_attr_t* const p_notice_attr ) { - return ((cl_ntoh16( p_notice_attr->combo3 ) & 0xFFFE) >> 1); + return ((cl_ntoh16( p_notice_attr->combo3 ) & 0xFFFE) >> 1); }

PARAMETERS

@@ -6944,12 +6949,12 @@ IBA Base: Types/ib_notice_get_count Returns the notice toggle count of the notice.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_set_count
+
       ib_mad_notice_attr_t, ib_notice_set_count
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_get_dev_id

[top][index]

@@ -6964,7 +6969,7 @@ IBA Base: Types/ib_notice_get_dev_id

ib_notice_get_dev_id( IN const ib_mad_notice_attr_t* const p_notice_attr ) { - return ib_notice_get_trap_num( p_notice_attr ); + return ib_notice_get_trap_num( p_notice_attr ); }

PARAMETERS

@@ -6976,12 +6981,12 @@ IBA Base: Types/ib_notice_get_dev_id Returns the vendor ID of the notice, in host byte order.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_set_dev_id
+
       ib_mad_notice_attr_t, ib_notice_set_dev_id
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_get_generic

[top][index]

@@ -6996,7 +7001,7 @@ IBA Base: Types/ib_notice_get_generic

ib_notice_get_generic( IN const ib_mad_notice_attr_t* const p_notice_attr ) { - if( cl_ntoh32( p_notice_attr->combo1 ) & 0x00000001 ) + if( cl_ntoh32( p_notice_attr->combo1 ) & 0x00000001 ) return TRUE; return FALSE; } @@ -7012,12 +7017,12 @@ IBA Base: Types/ib_notice_get_generic Returns FALSE if the notice is vendor specific.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_set_generic
+
       ib_mad_notice_attr_t, ib_notice_set_generic
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_get_prod_type

[top][index]

@@ -7032,7 +7037,7 @@ IBA Base: Types/ib_notice_get_prod_type

ib_notice_get_prod_type( IN const ib_mad_notice_attr_t* const p_notice_attr ) { - return (cl_ntoh32( p_notice_attr->combo1 ) >> 8); + return (cl_ntoh32( p_notice_attr->combo1 ) >> 8); }

PARAMETERS

@@ -7044,12 +7049,12 @@ IBA Base: Types/ib_notice_get_prod_type Returns the producer type of the notice, in host byte order.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_set_prod_type
+
       ib_mad_notice_attr_t, ib_notice_set_prod_type
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_get_toggle

[top][index]

@@ -7064,7 +7069,7 @@ IBA Base: Types/ib_notice_get_toggle

ib_notice_get_toggle( IN const ib_mad_notice_attr_t* const p_notice_attr ) { - return (cl_ntoh16( p_notice_attr->combo3 ) & 0x0001); + return (cl_ntoh16( p_notice_attr->combo3 ) & 0x0001); }

PARAMETERS

@@ -7078,12 +7083,12 @@ IBA Base: Types/ib_notice_get_toggle Returns FALSE otherwise.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_set_toggle
+
       ib_mad_notice_attr_t, ib_notice_set_toggle
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_get_trap_num

[top][index]

@@ -7098,7 +7103,7 @@ IBA Base: Types/ib_notice_get_trap_num

ib_notice_get_trap_num( IN const ib_mad_notice_attr_t* const p_notice_attr ) { - return cl_ntoh16( p_notice_attr->combo2 ); + return cl_ntoh16( p_notice_attr->combo2 ); }

PARAMETERS

@@ -7110,12 +7115,12 @@ IBA Base: Types/ib_notice_get_trap_num Returns the vendor ID of the notice, in host byte order.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_set_trap_num
+
       ib_mad_notice_attr_t, ib_notice_set_trap_num
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_get_type

[top][index]

@@ -7130,7 +7135,7 @@ IBA Base: Types/ib_notice_get_type

ib_notice_get_type( IN const ib_mad_notice_attr_t* const p_notice_attr ) { - return (uint8_t)((cl_ntoh32( p_notice_attr->combo1 ) >> 1) & 0x0000007F); + return (uint8_t)((cl_ntoh32( p_notice_attr->combo1 ) >> 1) & 0x0000007F); }

PARAMETERS

@@ -7141,12 +7146,12 @@ IBA Base: Types/ib_notice_get_type Returns the type of the notice.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_set_type
+
       ib_mad_notice_attr_t, ib_notice_set_type
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_get_vend_id

[top][index]

@@ -7161,7 +7166,7 @@ IBA Base: Types/ib_notice_get_vend_id

ib_notice_get_vend_id( IN const ib_mad_notice_attr_t* const p_notice_attr ) { - return ib_notice_get_prod_type( p_notice_attr ); + return ib_notice_get_prod_type( p_notice_attr ); }

PARAMETERS

@@ -7173,12 +7178,12 @@ IBA Base: Types/ib_notice_get_vend_id Returns the vendor ID of the notice, in host byte order.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_set_vend_id
+
       ib_mad_notice_attr_t, ib_notice_set_vend_id
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_set_count

[top][index]

@@ -7195,10 +7200,10 @@ IBA Base: Types/ib_notice_set_count

IN const uint16_t toggle_cnt ) { uint16_t val; - val = cl_ntoh16( p_notice_attr->combo3 ); + val = cl_ntoh16( p_notice_attr->combo3 ); val &= 0x0001; val |= (toggle_cnt << 1); - p_notice_attr->combo3 = cl_hton16( val ); + p_notice_attr->combo3 = cl_hton16( val ); }

PARAMETERS

@@ -7213,12 +7218,12 @@ IBA Base: Types/ib_notice_set_count This function does not return a value.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_get_count
+
       ib_mad_notice_attr_t, ib_notice_get_count
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_set_dev_id

[top][index]

@@ -7234,7 +7239,7 @@ IBA Base: Types/ib_notice_set_dev_id

IN OUT ib_mad_notice_attr_t* const p_notice_attr, IN const uint16_t dev_id ) { - ib_notice_set_trap_num( p_notice_attr, dev_id ); + ib_notice_set_trap_num( p_notice_attr, dev_id ); }

PARAMETERS

@@ -7249,12 +7254,12 @@ IBA Base: Types/ib_notice_set_dev_id This function does not return a value.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_get_dev_id
+
       ib_mad_notice_attr_t, ib_notice_get_dev_id
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_set_generic

[top][index]

@@ -7272,12 +7277,12 @@ IBA Base: Types/ib_notice_set_generic

{ uint32_t val; - val = cl_ntoh32( p_notice_attr->combo1 ); + val = cl_ntoh32( p_notice_attr->combo1 ); if( is_generic ) val |= 0x00000001; else val &= 0xFFFFFFFE; - p_notice_attr->combo1 = cl_hton32( val ); + p_notice_attr->combo1 = cl_hton32( val ); }

PARAMETERS

@@ -7292,12 +7297,12 @@ IBA Base: Types/ib_notice_set_generic This function does not return a value.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_get_generic
+
       ib_mad_notice_attr_t, ib_notice_get_generic
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_set_prod_type

[top][index]

@@ -7315,12 +7320,12 @@ IBA Base: Types/ib_notice_set_prod_type

{ uint32_t val; - val = cl_ntoh32( p_notice_attr->combo1 ); + val = cl_ntoh32( p_notice_attr->combo1 ); /* Clear the type. */ val &= 0x000000FF; /* Set new value. */ val |= (prod_type << 8); - p_notice_attr->combo1 = cl_hton32( val ); + p_notice_attr->combo1 = cl_hton32( val ); }

PARAMETERS

@@ -7335,12 +7340,12 @@ IBA Base: Types/ib_notice_set_prod_type This function does not return a value.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_get_prod_type
+
       ib_mad_notice_attr_t, ib_notice_get_prod_type
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_set_toggle

[top][index]

@@ -7357,12 +7362,12 @@ IBA Base: Types/ib_notice_set_toggle

IN const boolean_t toggle_val ) { uint16_t val; - val = cl_ntoh16( p_notice_attr->combo3 ); + val = cl_ntoh16( p_notice_attr->combo3 ); if( toggle_val ) val |= 0x0001; else val &= 0xFFFE; - p_notice_attr->combo3 = cl_hton16( val ); + p_notice_attr->combo3 = cl_hton16( val ); }

PARAMETERS

@@ -7378,12 +7383,12 @@ IBA Base: Types/ib_notice_set_toggle This function does not return a value.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_get_toggle
+
       ib_mad_notice_attr_t, ib_notice_get_toggle
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_set_trap_num

[top][index]

@@ -7399,7 +7404,7 @@ IBA Base: Types/ib_notice_set_trap_num

IN OUT ib_mad_notice_attr_t* const p_notice_attr, IN const uint16_t trap_num ) { - p_notice_attr->combo2 = cl_hton16( trap_num ); + p_notice_attr->combo2 = cl_hton16( trap_num ); }

PARAMETERS

@@ -7414,12 +7419,12 @@ IBA Base: Types/ib_notice_set_trap_num This function does not return a value.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_get_trap_num
+
       ib_mad_notice_attr_t, ib_notice_get_trap_num
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_set_type

[top][index]

@@ -7437,12 +7442,12 @@ IBA Base: Types/ib_notice_set_type

{ uint32_t val; - val = cl_ntoh32( p_notice_attr->combo1 ); + val = cl_ntoh32( p_notice_attr->combo1 ); /* Clear the type. */ val &= 0xFFFFFF01; /* Set new value. */ val |= (((uint32_t)(type & 0x7F)) << 1); - p_notice_attr->combo1 = cl_hton32( val ); + p_notice_attr->combo1 = cl_hton32( val ); }

PARAMETERS

@@ -7456,12 +7461,12 @@ IBA Base: Types/ib_notice_set_type This function does not return a value.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_get_type
+
       ib_mad_notice_attr_t, ib_notice_get_type
 

-

[Functions] +

[Functions] IBA Base: Types/ib_notice_set_vend_id

[top][index]

@@ -7477,7 +7482,7 @@ IBA Base: Types/ib_notice_set_vend_id

IN OUT ib_mad_notice_attr_t* const p_notice_attr, IN const uint32_t vend_id ) { - ib_notice_set_prod_type( p_notice_attr, vend_id ); + ib_notice_set_prod_type( p_notice_attr, vend_id ); }

PARAMETERS

@@ -7492,12 +7497,12 @@ IBA Base: Types/ib_notice_set_vend_id This function does not return a value.

SEE ALSO

-
       ib_mad_notice_attr_t, ib_notice_get_vend_id
+
       ib_mad_notice_attr_t, ib_notice_get_vend_id
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_get_ipd

[top][index]

@@ -7572,7 +7577,7 @@ IBA Base: Types/ib_path_get_ipd


-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_flow_lbl

[top][index]

@@ -7585,9 +7590,9 @@ IBA Base: Types/ib_path_rec_flow_lbl

SYNOPSIS

AL_INLINE net32_t AL_API
 ib_path_rec_flow_lbl(
-        IN              const   ib_path_rec_t* const            p_rec )
+        IN              const   ib_path_rec_t* const            p_rec )
 {
-        return( cl_hton32( (cl_ntoh32(p_rec->hop_flow_raw.val) >> 8) & 0x000FFFFF ) );
+        return( cl_hton32( (cl_ntoh32(p_rec->hop_flow_raw.val) >> 8) & 0x000FFFFF ) );
 }
 

PARAMETERS

@@ -7601,12 +7606,12 @@ IBA Base: Types/ib_path_rec_flow_lbl
 

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_hop_limit

[top][index]

@@ -7619,7 +7624,7 @@ IBA Base: Types/ib_path_rec_hop_limit

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_path_rec_hop_limit(
-        IN              const   ib_path_rec_t* const            p_rec )
+        IN              const   ib_path_rec_t* const            p_rec )
 {
         return( p_rec->hop_flow_raw.bytes[3] );
 }
@@ -7635,12 +7640,12 @@ IBA Base: Types/ib_path_rec_hop_limit
 
 

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_init_local

[top][index]

@@ -7653,13 +7658,13 @@ IBA Base: Types/ib_path_rec_init_local

SYNOPSIS

AL_INLINE void AL_API
 ib_path_rec_init_local(
-        IN                              ib_path_rec_t*  const           p_rec,
-        IN              const   ib_gid_t*               const           p_dgid,
-        IN              const   ib_gid_t*               const           p_sgid,
-        IN              const   ib_net16_t                                      dlid,
-        IN              const   ib_net16_t                                      slid,
+        IN                              ib_path_rec_t*  const           p_rec,
+        IN              const   ib_gid_t*               const           p_dgid,
+        IN              const   ib_gid_t*               const           p_sgid,
+        IN              const   ib_net16_t                                      dlid,
+        IN              const   ib_net16_t                                      slid,
         IN              const   uint8_t                                         num_path,
-        IN              const   ib_net16_t                                      pkey,
+        IN              const   ib_net16_t                                      pkey,
         IN              const   uint8_t                                         sl,
         IN              const   uint8_t                                         mtu_selector,
         IN              const   uint8_t                                         mtu,
@@ -7676,12 +7681,12 @@ IBA Base: Types/ib_path_rec_init_local
         p_rec->num_path = num_path;
         p_rec->pkey = pkey;
         /* Lower 4 bits of path rec's SL are reserved. */
-        p_rec->sl = cl_ntoh16( sl );
-        p_rec->mtu = (uint8_t)((mtu & IB_PATH_REC_BASE_MASK) |
+        p_rec->sl = cl_ntoh16( sl );
+        p_rec->mtu = (uint8_t)((mtu & IB_PATH_REC_BASE_MASK) |
                         (uint8_t)(mtu_selector << 6));
-        p_rec->rate = (uint8_t)((rate & IB_PATH_REC_BASE_MASK) |
+        p_rec->rate = (uint8_t)((rate & IB_PATH_REC_BASE_MASK) |
                         (uint8_t)(rate_selector << 6));
-        p_rec->pkt_life = (uint8_t)((pkt_life & IB_PATH_REC_BASE_MASK) |
+        p_rec->pkt_life = (uint8_t)((pkt_life & IB_PATH_REC_BASE_MASK) |
                         (uint8_t)(pkt_life_selector << 6));
         p_rec->preference = preference;
 
@@ -7749,12 +7754,12 @@ IBA Base: Types/ib_path_rec_init_local
 
 

SEE ALSO

-
       ib_gid_t
+
       ib_gid_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_mtu

[top][index]

@@ -7767,9 +7772,9 @@ IBA Base: Types/ib_path_rec_mtu

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_path_rec_mtu(
-        IN              const   ib_path_rec_t* const            p_rec )
+        IN              const   ib_path_rec_t* const            p_rec )
 {
-        return( (uint8_t)(p_rec->mtu & IB_PATH_REC_BASE_MASK) );
+        return( (uint8_t)(p_rec->mtu & IB_PATH_REC_BASE_MASK) );
 }
 

PARAMETERS

@@ -7789,12 +7794,12 @@ IBA Base: Types/ib_path_rec_mtu
 

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_mtu_sel

[top][index]

@@ -7807,9 +7812,9 @@ IBA Base: Types/ib_path_rec_mtu_sel

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_path_rec_mtu_sel(
-        IN              const   ib_path_rec_t* const            p_rec )
+        IN              const   ib_path_rec_t* const            p_rec )
 {
-        return( (uint8_t)((p_rec->mtu & IB_PATH_REC_SELECTOR_MASK) >> 6) );
+        return( (uint8_t)((p_rec->mtu & IB_PATH_REC_SELECTOR_MASK) >> 6) );
 }
 

PARAMETERS

@@ -7827,12 +7832,12 @@ IBA Base: Types/ib_path_rec_mtu_sel
 

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_pkt_life

[top][index]

@@ -7845,9 +7850,9 @@ IBA Base: Types/ib_path_rec_pkt_life

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_path_rec_pkt_life(
-        IN              const   ib_path_rec_t* const            p_rec )
+        IN              const   ib_path_rec_t* const            p_rec )
 {
-        return( (uint8_t)(p_rec->pkt_life & IB_PATH_REC_BASE_MASK) );
+        return( (uint8_t)(p_rec->pkt_life & IB_PATH_REC_BASE_MASK) );
 }
 

PARAMETERS

@@ -7861,12 +7866,12 @@ IBA Base: Types/ib_path_rec_pkt_life
 

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_pkt_life_sel

[top][index]

@@ -7879,9 +7884,9 @@ IBA Base: Types/ib_path_rec_pkt_life_sel

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_path_rec_pkt_life_sel(
-        IN              const   ib_path_rec_t* const            p_rec )
+        IN              const   ib_path_rec_t* const            p_rec )
 {
-        return( (uint8_t)((p_rec->pkt_life & IB_PATH_REC_SELECTOR_MASK) >> 6 ));
+        return( (uint8_t)((p_rec->pkt_life & IB_PATH_REC_SELECTOR_MASK) >> 6 ));
 }
 

PARAMETERS

@@ -7899,12 +7904,12 @@ IBA Base: Types/ib_path_rec_pkt_life_sel
 

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_rate

[top][index]

@@ -7917,9 +7922,9 @@ IBA Base: Types/ib_path_rec_rate

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_path_rec_rate(
-        IN              const   ib_path_rec_t* const            p_rec )
+        IN              const   ib_path_rec_t* const            p_rec )
 {
-        return( (uint8_t)(p_rec->rate & IB_PATH_REC_BASE_MASK) );
+        return( (uint8_t)(p_rec->rate & IB_PATH_REC_BASE_MASK) );
 }
 

PARAMETERS

@@ -7937,12 +7942,12 @@ IBA Base: Types/ib_path_rec_rate
 

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_rate_sel

[top][index]

@@ -7955,9 +7960,9 @@ IBA Base: Types/ib_path_rec_rate_sel

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_path_rec_rate_sel(
-        IN              const   ib_path_rec_t* const            p_rec )
+        IN              const   ib_path_rec_t* const            p_rec )
 {
-        return( (uint8_t)((p_rec->rate & IB_PATH_REC_SELECTOR_MASK) >> 6) );
+        return( (uint8_t)((p_rec->rate & IB_PATH_REC_SELECTOR_MASK) >> 6) );
 }
 

PARAMETERS

@@ -7975,12 +7980,12 @@ IBA Base: Types/ib_path_rec_rate_sel
 

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_set_hop_flow_raw

[top][index]

@@ -7993,15 +7998,15 @@ IBA Base: Types/ib_path_rec_set_hop_flow_raw

SYNOPSIS

AL_INLINE void AL_API
 ib_path_rec_set_hop_flow_raw(
-                OUT                     ib_path_rec_t* const            p_rec,
+                OUT                     ib_path_rec_t* const            p_rec,
         IN              const   uint8_t                                         hop_limit,
         IN              const   net32_t                                         flow_lbl,
         IN              const   boolean_t                                       raw )
 {
-        p_rec->hop_flow_raw.val = (cl_ntoh32( flow_lbl ) & 0x000FFFFF) << 8;
+        p_rec->hop_flow_raw.val = (cl_ntoh32( flow_lbl ) & 0x000FFFFF) << 8;
         if( raw )
                 p_rec->hop_flow_raw.val |= 0x80000000;
-        p_rec->hop_flow_raw.val = cl_hton32( p_rec->hop_flow_raw.val );
+        p_rec->hop_flow_raw.val = cl_hton32( p_rec->hop_flow_raw.val );
         p_rec->hop_flow_raw.bytes[3] = hop_limit;
 }
 
@@ -8020,12 +8025,12 @@ IBA Base: Types/ib_path_rec_set_hop_flow_raw Boolean flag to indicate whether the path record is for raw traffic.

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_path_rec_sl

[top][index]

@@ -8038,9 +8043,9 @@ IBA Base: Types/ib_path_rec_sl

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_path_rec_sl(
-        IN              const   ib_path_rec_t* const            p_rec )
+        IN              const   ib_path_rec_t* const            p_rec )
 {
-        return( (uint8_t)((cl_ntoh16( p_rec->sl )) & 0xF) );
+        return( (uint8_t)((cl_ntoh16( p_rec->sl )) & 0xF) );
 }
 

PARAMETERS

@@ -8060,12 +8065,12 @@ IBA Base: Types/ib_path_rec_sl
 

SEE ALSO

-
       ib_path_rec_t
+
       ib_path_rec_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_path_rec_t

[top][index]

@@ -8081,15 +8086,15 @@ IBA Base: Types/ib_path_rec_t

typedef __declspec(align(8)) struct _ib_path_rec { uint64_t resv0; - ib_gid_t dgid; - ib_gid_t sgid; - ib_net16_t dlid; - ib_net16_t slid; - ib_field32_t hop_flow_raw; + ib_gid_t dgid; + ib_gid_t sgid; + ib_net16_t dlid; + ib_net16_t slid; + ib_field32_t hop_flow_raw; uint8_t tclass; uint8_t num_path; - ib_net16_t pkey; - ib_net16_t sl; + ib_net16_t pkey; + ib_net16_t sl; uint8_t mtu; uint8_t rate; uint8_t pkt_life; @@ -8158,7 +8163,7 @@ typedef __declspec(align(8)) struct _ib_path_rec
-

[Functions] +

[Functions] IBA Base: Types/ib_pkey_get_base

[top][index]

@@ -8169,11 +8174,11 @@ IBA Base: Types/ib_pkey_get_base

       Returns the base P_Key value with the membership bit stripped.
 

SYNOPSIS

-
AL_INLINE ib_net16_t AL_API
+
AL_INLINE ib_net16_t AL_API
 ib_pkey_get_base(
-        IN              const   ib_net16_t                                      pkey )
+        IN              const   ib_net16_t                                      pkey )
 {
-        return( (ib_net16_t)(pkey & IB_PKEY_BASE_MASK) );
+        return( (ib_net16_t)(pkey & IB_PKEY_BASE_MASK) );
 }
 

PARAMETERS

@@ -8190,7 +8195,7 @@ IBA Base: Types/ib_pkey_get_base
-

[Functions] +

[Functions] IBA Base: Types/ib_pkey_is_full_member

[top][index]

@@ -8203,9 +8208,9 @@ IBA Base: Types/ib_pkey_is_full_member

SYNOPSIS

AL_INLINE boolean_t AL_API
 ib_pkey_is_full_member(
-        IN              const   ib_net16_t                                      pkey )
+        IN              const   ib_net16_t                                      pkey )
 {
-        return( (pkey & IB_PKEY_TYPE_MASK) == IB_PKEY_TYPE_MASK );
+        return( (pkey & IB_PKEY_TYPE_MASK) == IB_PKEY_TYPE_MASK );
 }
 

PARAMETERS

@@ -8220,12 +8225,12 @@ IBA Base: Types/ib_pkey_is_full_member
 

SEE ALSO

-
 ib_pkey_get_base, ib_net16_t
+
 ib_pkey_get_base, ib_net16_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_pkey_table_info_t

[top][index]

@@ -8241,7 +8246,7 @@ IBA Base: Types/ib_pkey_table_info_t

#include <complib/cl_packon.h> typedef struct _ib_pkey_table_info { - ib_net16_t pkey[PKEY_TABLE_MAX_ENTRIES]; + ib_net16_t pkey[PKEY_TABLE_MAX_ENTRIES]; } PACK_SUFFIX ib_pkey_table_info_t; #include <complib/cl_packoff.h> @@ -8249,12 +8254,12 @@ typedef struct _ib_pkey_table_info
-

[Structures] +

[Structures] IBA Base: Types/ib_port_counters_t

[top][index]

NAME

-
       ib_gmp_t
+
       ib_gmp_t
 

DESCRIPTION

       IBA defined PortCounters MAD format. (16.1.3.5)
@@ -8265,26 +8270,26 @@ typedef struct _ib_port_counters
 {
         uint8_t                 reserved0;
         uint8_t                 port_select;
-        ib_net16_t              counter_select;
-        ib_net16_t              symbol_error_counter; 
+        ib_net16_t              counter_select;
+        ib_net16_t              symbol_error_counter; 
         uint8_t                 link_error_recovery_counter;
         uint8_t                 link_down_counter; 
-        ib_net16_t              port_rcv_errors; 
-        ib_net16_t              port_rcv_remote_physical_errors;
-        ib_net16_t              port_rcv_switch_relay_errors; 
-        ib_net16_t              port_xmit_discard; 
+        ib_net16_t              port_rcv_errors; 
+        ib_net16_t              port_rcv_remote_physical_errors;
+        ib_net16_t              port_rcv_switch_relay_errors; 
+        ib_net16_t              port_xmit_discard; 
         uint8_t                 port_xmit_constraint_errors;
         uint8_t                 port_rcv_constraint_errors;
         uint8_t                 reserved1;
         /* uint4_t excessive_buffer_overrun_errors;
         uint4_t local_link_integrity_errors; */
         uint8_t                 lli_errors_exc_buf_errors;
-        ib_net16_t              reserved2; 
-        ib_net16_t              vl15_dropped;
-        ib_net32_t              port_xmit_data;
-        ib_net32_t              port_rcv_data;
-        ib_net32_t              port_xmit_pkts;
-        ib_net32_t              port_rcv_pkts;
+        ib_net16_t              reserved2; 
+        ib_net16_t              vl15_dropped;
+        ib_net32_t              port_xmit_data;
+        ib_net32_t              port_rcv_data;
+        ib_net32_t              port_xmit_pkts;
+        ib_net32_t              port_rcv_pkts;
 
 }       PACK_SUFFIX ib_port_counters_t;
 #include <complib/cl_packoff.h>
@@ -8292,7 +8297,7 @@ typedef struct _ib_port_counters
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_compute_rate

[top][index]

@@ -8305,10 +8310,10 @@ IBA Base: Types/ib_port_info_compute_rate

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_compute_rate(
-        IN              const   ib_port_info_t* const           p_pi )
+        IN              const   ib_port_info_t* const           p_pi )
 {
         switch( p_pi->link_width_active * p_pi->link_width_active *
-                ib_port_info_get_link_speed_active( p_pi ) )
+                ib_port_info_get_link_speed_active( p_pi ) )
         {
         case 1:
                 return IB_PATH_RECORD_RATE_2_5_GBS;
@@ -8353,7 +8358,7 @@ IBA Base: Types/ib_port_info_compute_rate


-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_get_link_speed_active

[top][index]

@@ -8366,7 +8371,7 @@ IBA Base: Types/ib_port_info_get_link_speed_active

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_get_link_speed_active(
-        IN              const   ib_port_info_t* const           p_pi )
+        IN              const   ib_port_info_t* const           p_pi )
 {
         return( (uint8_t)((p_pi->link_speed & IB_PORT_LINK_SPEED_ACTIVE_MASK) >>
                 IB_PORT_LINK_SPEED_SHIFT) );
@@ -8386,7 +8391,7 @@ IBA Base: Types/ib_port_info_get_link_speed_active
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_get_link_speed_sup

[top][index]

@@ -8399,7 +8404,7 @@ IBA Base: Types/ib_port_info_get_link_speed_sup

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_get_link_speed_sup(
-        IN              const   ib_port_info_t* const           p_pi )
+        IN              const   ib_port_info_t* const           p_pi )
 {
         return( (uint8_t)((p_pi->state_info1 &
                         IB_PORT_LINK_SPEED_SUPPORTED_MASK) >>
@@ -8420,7 +8425,7 @@ IBA Base: Types/ib_port_info_get_link_speed_sup
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_get_lmc

[top][index]

@@ -8433,7 +8438,7 @@ IBA Base: Types/ib_port_info_get_lmc

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_get_lmc(
-        IN              const   ib_port_info_t* const           p_pi )
+        IN              const   ib_port_info_t* const           p_pi )
 {
         return( (uint8_t)(p_pi->mkey_lmc & IB_PORT_LMC_MASK) );
 }
@@ -8452,7 +8457,7 @@ IBA Base: Types/ib_port_info_get_lmc
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_get_mpb

[top][index]

@@ -8465,7 +8470,7 @@ IBA Base: Types/ib_port_info_get_mpb

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_get_mpb(
-        IN              const   ib_port_info_t* const           p_pi )
+        IN              const   ib_port_info_t* const           p_pi )
 {
         return( (uint8_t)((p_pi->mkey_lmc & IB_PORT_MPB_MASK) >>
                         IB_PORT_MPB_SHIFT) );
@@ -8485,7 +8490,7 @@ IBA Base: Types/ib_port_info_get_mpb
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_get_mtu_cap

[top][index]

@@ -8498,7 +8503,7 @@ IBA Base: Types/ib_port_info_get_mtu_cap

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_get_mtu_cap(
-        IN              const   ib_port_info_t* const           p_pi )
+        IN              const   ib_port_info_t* const           p_pi )
 {
         return( (uint8_t)(p_pi->mtu_cap & 0x0F) );
 }
@@ -8517,7 +8522,7 @@ IBA Base: Types/ib_port_info_get_mtu_cap
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_get_neighbor_mtu

[top][index]

@@ -8530,7 +8535,7 @@ IBA Base: Types/ib_port_info_get_neighbor_mtu

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_get_neighbor_mtu(
-        IN const ib_port_info_t* const p_pi )
+        IN const ib_port_info_t* const p_pi )
 {
         return( (uint8_t)((p_pi->mtu_smsl & 0xF0) >> 4) );
 }
@@ -8549,7 +8554,7 @@ IBA Base: Types/ib_port_info_get_neighbor_mtu
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_get_op_vls

[top][index]

@@ -8562,7 +8567,7 @@ IBA Base: Types/ib_port_info_get_op_vls

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_get_op_vls(
-        IN const ib_port_info_t* const p_pi)
+        IN const ib_port_info_t* const p_pi)
 {
         return((p_pi->vl_enforce >> 4) & 0x0F);
 }
@@ -8581,7 +8586,7 @@ IBA Base: Types/ib_port_info_get_op_vls
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_get_port_state

[top][index]

@@ -8594,7 +8599,7 @@ IBA Base: Types/ib_port_info_get_port_state

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_get_port_state(
-        IN              const   ib_port_info_t* const           p_pi )
+        IN              const   ib_port_info_t* const           p_pi )
 {
         return( (uint8_t)(p_pi->state_info1 & IB_PORT_STATE_MASK) );
 }
@@ -8613,7 +8618,39 @@ IBA Base: Types/ib_port_info_get_port_state
 
 
-

[Functions] +

[Functions] +IBA Base: Types/ib_port_info_get_sm_sl

+ +

[top][index]

+

NAME

+
       ib_port_info_get_sm_sl
+
+

DESCRIPTION

+
       Returns the encoded value for the SM sl at this port.
+
+

SYNOPSIS

+
AL_INLINE uint8_t AL_API
+ib_port_info_get_sm_sl(
+        IN const ib_port_info_t* const p_pi )
+{
+        return( (uint8_t)(p_pi->mtu_smsl & 0x0F) );
+}
+
+

PARAMETERS

+
       p_pi
+               [in] Pointer to a PortInfo attribute.
+
+ RETURN VALUES
+       Returns the encoded value for the neighbor MTU at this port.
+
+

NOTES

+
+
+

SEE ALSO

+ +
+ +

[Functions] IBA Base: Types/ib_port_info_get_vl_cap

[top][index]

@@ -8626,7 +8663,7 @@ IBA Base: Types/ib_port_info_get_vl_cap

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_port_info_get_vl_cap(
-        IN const ib_port_info_t* const p_pi)
+        IN const ib_port_info_t* const p_pi)
 {
         return((p_pi->vl_cap >> 4) & 0x0F);
 }
@@ -8645,7 +8682,7 @@ IBA Base: Types/ib_port_info_get_vl_cap
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_set_link_speed_sup

[top][index]

@@ -8660,7 +8697,7 @@ IBA Base: Types/ib_port_info_set_link_speed_sup

AL_INLINE void AL_API
 ib_port_info_set_link_speed_sup(
         IN                              uint8_t const                           speed,
-        IN                              ib_port_info_t*                         p_pi )
+        IN                              ib_port_info_t*                         p_pi )
 {
         p_pi->state_info1 =
                 ( ~IB_PORT_LINK_SPEED_SUPPORTED_MASK & p_pi->state_info1 ) |
@@ -8685,7 +8722,7 @@ IBA Base: Types/ib_port_info_set_link_speed_sup
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_set_lmc

[top][index]

@@ -8698,7 +8735,7 @@ IBA Base: Types/ib_port_info_set_lmc

SYNOPSIS

AL_INLINE void AL_API
 ib_port_info_set_lmc(
-        IN                              ib_port_info_t* const           p_pi,
+        IN                              ib_port_info_t* const           p_pi,
         IN              const   uint8_t                                         lmc )
 {
         CL_ASSERT( lmc <= 0x7 );
@@ -8722,7 +8759,7 @@ IBA Base: Types/ib_port_info_set_lmc
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_set_mpb

[top][index]

@@ -8735,7 +8772,7 @@ IBA Base: Types/ib_port_info_set_mpb

SYNOPSIS

AL_INLINE void AL_API
 ib_port_info_set_mpb(
-        IN                              ib_port_info_t*                         p_pi,
+        IN                              ib_port_info_t*                         p_pi,
         IN                              uint8_t                                         mpb )
 {
         p_pi->mkey_lmc =
@@ -8758,7 +8795,7 @@ IBA Base: Types/ib_port_info_set_mpb
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_set_neighbor_mtu

[top][index]

@@ -8771,7 +8808,7 @@ IBA Base: Types/ib_port_info_set_neighbor_mtu

SYNOPSIS

AL_INLINE void AL_API
 ib_port_info_set_neighbor_mtu(
-        IN                              ib_port_info_t* const           p_pi,
+        IN                              ib_port_info_t* const           p_pi,
         IN              const   uint8_t                                         mtu )
 {
         CL_ASSERT( mtu <= 5 );
@@ -8796,7 +8833,7 @@ IBA Base: Types/ib_port_info_set_neighbor_mtu
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_set_op_vls

[top][index]

@@ -8809,7 +8846,7 @@ IBA Base: Types/ib_port_info_set_op_vls

SYNOPSIS

AL_INLINE void AL_API
 ib_port_info_set_op_vls(
-        IN                              ib_port_info_t* const           p_pi,
+        IN                              ib_port_info_t* const           p_pi,
         IN              const   uint8_t                                         op_vls )
 {
         p_pi->vl_enforce = (uint8_t)((p_pi->vl_enforce & 0x0F) | (op_vls << 4) );
@@ -8832,7 +8869,7 @@ IBA Base: Types/ib_port_info_set_op_vls
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_set_port_state

[top][index]

@@ -8845,7 +8882,7 @@ IBA Base: Types/ib_port_info_set_port_state

SYNOPSIS

AL_INLINE void AL_API
 ib_port_info_set_port_state(
-        IN                              ib_port_info_t* const           p_pi,
+        IN                              ib_port_info_t* const           p_pi,
         IN              const   uint8_t                                         port_state )
 {
         p_pi->state_info1 = (uint8_t)((p_pi->state_info1 & 0xF0) | port_state );
@@ -8868,7 +8905,45 @@ IBA Base: Types/ib_port_info_set_port_state
 
 
-

[Functions] +

[Functions] +IBA Base: Types/ib_port_info_set_sm_sl

+ +

[top][index]

+

NAME

+
       ib_port_info_set_sm_sl
+
+

DESCRIPTION

+
       Sets the SM sl value in the PortInfo attribute.
+
+

SYNOPSIS

+
AL_INLINE void AL_API
+ib_port_info_set_sm_sl(
+        IN                              ib_port_info_t* const           p_pi,
+        IN              const   uint8_t                                         sm_sl )
+{
+        CL_ASSERT( sm_sl<= 5 );
+        CL_ASSERT( sm_sl != 0 );
+        p_pi->mtu_smsl = (uint8_t)((p_pi->mtu_smsl & 0xF0) | sm_sl );
+}
+
+

PARAMETERS

+
       p_pi
+               [in] Pointer to a PortInfo attribute.
+
+       mtu
+               [in] Encoded SM sl value to set
+
+ RETURN VALUES
+       None.
+
+

NOTES

+
+
+

SEE ALSO

+ +
+ +

[Functions] IBA Base: Types/ib_port_info_set_state_no_change

[top][index]

@@ -8881,9 +8956,9 @@ IBA Base: Types/ib_port_info_set_state_no_change

SYNOPSIS

AL_INLINE void AL_API
 ib_port_info_set_state_no_change(
-        IN                              ib_port_info_t* const           p_pi )
+        IN                              ib_port_info_t* const           p_pi )
 {
-        ib_port_info_set_port_state( p_pi, 0 );
+        ib_port_info_set_port_state( p_pi, 0 );
         p_pi->state_info2 = 0;
 }
 
@@ -8901,7 +8976,7 @@ IBA Base: Types/ib_port_info_set_state_no_change
-

[Functions] +

[Functions] IBA Base: Types/ib_port_info_set_timeout

[top][index]

@@ -8914,7 +8989,7 @@ IBA Base: Types/ib_port_info_set_timeout

SYNOPSIS

AL_INLINE void AL_API
 ib_port_info_set_timeout(
-        IN                              ib_port_info_t* const           p_pi,
+        IN                              ib_port_info_t* const           p_pi,
         IN              const   uint8_t                                         timeout )
 {
         CL_ASSERT( timeout <= 0x1F );
@@ -8938,7 +9013,7 @@ IBA Base: Types/ib_port_info_set_timeout
 
 
-

[Structures] +

[Structures] IBA Base: Types/ib_port_info_t

[top][index]

@@ -8952,13 +9027,13 @@ IBA Base: Types/ib_port_info_t

#include <complib/cl_packon.h>
 typedef struct _ib_port_info
 {
-        ib_net64_t                      m_key;
-        ib_net64_t                      subnet_prefix;
-        ib_net16_t                      base_lid;
-        ib_net16_t                      master_sm_base_lid;
-        ib_net32_t                      capability_mask;
-        ib_net16_t                      diag_code;
-        ib_net16_t                      m_key_lease_period;
+        ib_net64_t                      m_key;
+        ib_net64_t                      subnet_prefix;
+        ib_net16_t                      base_lid;
+        ib_net16_t                      master_sm_base_lid;
+        ib_net32_t                      capability_mask;
+        ib_net16_t                      diag_code;
+        ib_net16_t                      m_key_lease_period;
         uint8_t                         local_port_num;
         uint8_t                         link_width_enabled;
         uint8_t                         link_width_supported;
@@ -8975,9 +9050,9 @@ typedef struct _ib_port_info
         uint8_t                         mtu_cap;
         uint8_t                         vl_stall_life;
         uint8_t                         vl_enforce;
-        ib_net16_t                      m_key_violations;
-        ib_net16_t                      p_key_violations;
-        ib_net16_t                      q_key_violations;
+        ib_net16_t                      m_key_violations;
+        ib_net16_t                      p_key_violations;
+        ib_net16_t                      q_key_violations;
         uint8_t                         guid_cap;
         uint8_t                         subnet_timeout;
         uint8_t                         resp_time_value;
@@ -8989,7 +9064,7 @@ typedef struct _ib_port_info
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_rmpp_is_flag_set

[top][index]

@@ -9002,7 +9077,7 @@ IBA Base: Types/ib_rmpp_is_flag_set

SYNOPSIS

AL_INLINE boolean_t AL_API
 ib_rmpp_is_flag_set(
-        IN              const   ib_rmpp_mad_t* const            p_rmpp_mad,
+        IN              const   ib_rmpp_mad_t* const            p_rmpp_mad,
         IN              const   uint8_t                                         flag )
 {
         CL_ASSERT( p_rmpp_mad );
@@ -9010,7 +9085,7 @@ IBA Base: Types/ib_rmpp_is_flag_set
 }
 

PARAMETERS

-
       ib_rmpp_mad_t
+
       ib_rmpp_mad_t
                [in] Pointer to a MAD with an RMPP header.
 
        flag
@@ -9023,12 +9098,12 @@ IBA Base: Types/ib_rmpp_is_flag_set
 
 

SEE ALSO

-
       ib_mad_t, ib_rmpp_mad_t
+
       ib_mad_t, ib_rmpp_mad_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_rmpp_mad_t

[top][index]

@@ -9042,26 +9117,26 @@ IBA Base: Types/ib_rmpp_mad_t

#include <complib/cl_packon.h>
 typedef struct _ib_rmpp_mad
 {
-        ib_mad_t                                common_hdr;
+        ib_mad_t                                common_hdr;
 
         uint8_t                                 rmpp_version;
         uint8_t                                 rmpp_type;
         uint8_t                                 rmpp_flags;
         uint8_t                                 rmpp_status;
 
-        ib_net32_t                              seg_num;
-        ib_net32_t                              paylen_newwin;
+        ib_net32_t                              seg_num;
+        ib_net32_t                              paylen_newwin;
 
 }       PACK_SUFFIX ib_rmpp_mad_t;
 #include <complib/cl_packoff.h>
 

SEE ALSO

-
       ib_mad_t
+
       ib_mad_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_sa_mad_get_payload_ptr

[top][index]

@@ -9074,7 +9149,7 @@ IBA Base: Types/ib_sa_mad_get_payload_ptr

SYNOPSIS

AL_INLINE void* AL_API
 ib_sa_mad_get_payload_ptr(
-        IN              const   ib_sa_mad_t* const                      p_sa_mad )
+        IN              const   ib_sa_mad_t* const                      p_sa_mad )
 {
         return( (void*)p_sa_mad->data );
 }
@@ -9090,12 +9165,12 @@ IBA Base: Types/ib_sa_mad_get_payload_ptr
 
 

SEE ALSO

-
       ib_mad_t
+
       ib_mad_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_sa_mad_t

[top][index]

@@ -9115,27 +9190,27 @@ typedef struct _ib_sa_mad uint8_t mgmt_class; uint8_t class_ver; uint8_t method; - ib_net16_t status; - ib_net16_t resv; - ib_net64_t trans_id; - ib_net16_t attr_id; - ib_net16_t resv1; - ib_net32_t attr_mod; + ib_net16_t status; + ib_net16_t resv; + ib_net64_t trans_id; + ib_net16_t attr_id; + ib_net16_t resv1; + ib_net32_t attr_mod; uint8_t rmpp_version; uint8_t rmpp_type; uint8_t rmpp_flags; uint8_t rmpp_status; - ib_net32_t seg_num; - ib_net32_t paylen_newwin; + ib_net32_t seg_num; + ib_net32_t paylen_newwin; - ib_net64_t sm_key; + ib_net64_t sm_key; - ib_net16_t attr_offset; - ib_net16_t resv3; + ib_net16_t attr_offset; + ib_net16_t resv3; - ib_net64_t comp_mask; + ib_net64_t comp_mask; uint8_t data[IB_SA_DATA_SIZE]; } PACK_SUFFIX ib_sa_mad_t; @@ -9144,7 +9219,7 @@ typedef struct _ib_sa_mad
-

[Functions] +

[Functions] IBA Base: Types/ib_slvl_table_get_vl

[top][index]

@@ -9157,7 +9232,7 @@ IBA Base: Types/ib_slvl_table_get_vl

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_slvl_table_get_vl(
-        IN              const   ib_slvl_table_t* const          p_slvl_tbl,
+        IN              const   ib_slvl_table_t* const          p_slvl_tbl,
         IN              const   uint8_t                                         sl )
 {
         uint8_t vl;
@@ -9183,12 +9258,12 @@ IBA Base: Types/ib_slvl_table_get_vl
        Returns the VL value for the specified SL in the provided table.
 

SEE ALSO

-
       ib_slvl_table_t, ib_slvl_table_set_vl
+
       ib_slvl_table_t, ib_slvl_table_set_vl
 

-

[Structures] +

[Structures] IBA Base: Types/ib_slvl_table_record_t

[top][index]

@@ -9202,11 +9277,11 @@ IBA Base: Types/ib_slvl_table_record_t

#include <complib/cl_packon.h>
 typedef struct _ib_slvl_table_record
 {
-        ib_net16_t              lid; // for CA: lid of port, for switch lid of port 0
+        ib_net16_t              lid; // for CA: lid of port, for switch lid of port 0
         uint8_t                 in_port_num;    // reserved for CA's
         uint8_t                 out_port_num;   // reserved for CA's
         uint32_t                resv;
-        ib_slvl_table_t slvl_tbl;
+        ib_slvl_table_t slvl_tbl;
 
 }       PACK_SUFFIX ib_slvl_table_record_t;
 #include <complib/cl_packoff.h>
@@ -9214,7 +9289,7 @@ typedef struct _ib_slvl_table_record
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_slvl_table_set_vl

[top][index]

@@ -9227,7 +9302,7 @@ IBA Base: Types/ib_slvl_table_set_vl

SYNOPSIS

AL_INLINE void AL_API
 ib_slvl_table_set_vl(
-        IN      OUT                     ib_slvl_table_t* const          p_slvl_tbl,
+        IN      OUT                     ib_slvl_table_t* const          p_slvl_tbl,
         IN              const   uint8_t                                         sl,
         IN              const   uint8_t                                         vl )
 {
@@ -9265,12 +9340,12 @@ IBA Base: Types/ib_slvl_table_set_vl
        This function does not return a value.
 

SEE ALSO

-
       ib_slvl_table_t, ib_slvl_table_get_vl
+
       ib_slvl_table_t, ib_slvl_table_get_vl
 

-

[Structures] +

[Structures] IBA Base: Types/ib_slvl_table_t

[top][index]

@@ -9292,7 +9367,7 @@ typedef struct _ib_slvl_table
-

[Structures] +

[Structures] IBA Base: Types/ib_sm_info_t

[top][index]

@@ -9306,9 +9381,9 @@ IBA Base: Types/ib_sm_info_t

#include <complib/cl_packon.h>
 typedef struct _ib_sm_info
 {
-        ib_net64_t                      guid;
-        ib_net64_t                      sm_key;
-        ib_net32_t                      act_count;
+        ib_net64_t                      guid;
+        ib_net64_t                      sm_key;
+        ib_net32_t                      act_count;
         uint8_t                         pri_state;
 
 }       PACK_SUFFIX ib_sm_info_t;
@@ -9331,7 +9406,7 @@ typedef struct _ib_sm_info
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_sminfo_get_priority

[top][index]

@@ -9344,7 +9419,7 @@ IBA Base: Types/ib_sminfo_get_priority

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_sminfo_get_priority(
-        IN              const   ib_sm_info_t* const                     p_smi )
+        IN              const   ib_sm_info_t* const                     p_smi )
 {
         return( (uint8_t)((p_smi->pri_state & 0xF0)>>4) );
 }
@@ -9363,7 +9438,7 @@ IBA Base: Types/ib_sminfo_get_priority
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_sminfo_get_state

[top][index]

@@ -9376,7 +9451,7 @@ IBA Base: Types/ib_sminfo_get_state

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_sminfo_get_state(
-        IN              const   ib_sm_info_t* const                     p_smi )
+        IN              const   ib_sm_info_t* const                     p_smi )
 {
         return( (uint8_t)(p_smi->pri_state & 0x0F) );
 }
@@ -9395,7 +9470,7 @@ IBA Base: Types/ib_sminfo_get_state
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_smp_get_payload_ptr

[top][index]

@@ -9408,7 +9483,7 @@ IBA Base: Types/ib_smp_get_payload_ptr

SYNOPSIS

AL_INLINE void* AL_API
 ib_smp_get_payload_ptr(
-        IN              const   ib_smp_t* const                         p_smp )
+        IN              const   ib_smp_t* const                         p_smp )
 {
         return( (void*)p_smp->data );
 }
@@ -9424,12 +9499,12 @@ IBA Base: Types/ib_smp_get_payload_ptr
 
 

SEE ALSO

-
       ib_mad_t
+
       ib_mad_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_smp_get_status

[top][index]

@@ -9440,11 +9515,11 @@ IBA Base: Types/ib_smp_get_status

       Returns the SMP status value in network order.
 

SYNOPSIS

-
AL_INLINE ib_net16_t AL_API
+
AL_INLINE ib_net16_t AL_API
 ib_smp_get_status(
-        IN              const   ib_smp_t* const                         p_smp )
+        IN              const   ib_smp_t* const                         p_smp )
 {
-        return( (ib_net16_t)(p_smp->status & IB_SMP_STATUS_MASK) );
+        return( (ib_net16_t)(p_smp->status & IB_SMP_STATUS_MASK) );
 }
 

PARAMETERS

@@ -9458,12 +9533,12 @@ IBA Base: Types/ib_smp_get_status
 

SEE ALSO

-
       ib_smp_t
+
       ib_smp_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_smp_init_new

[top][index]

@@ -9480,21 +9555,21 @@ IBA Base: Types/ib_smp_init_new

SYNOPSIS

AL_INLINE void AL_API
 ib_smp_init_new(
-        IN                              ib_smp_t* const                         p_smp,
+        IN                              ib_smp_t* const                         p_smp,
         IN              const   uint8_t                                         method,
-        IN              const   ib_net64_t                                      trans_id,
-        IN              const   ib_net16_t                                      attr_id,
-        IN              const   ib_net32_t                                      attr_mod,
+        IN              const   ib_net64_t                                      trans_id,
+        IN              const   ib_net16_t                                      attr_id,
+        IN              const   ib_net32_t                                      attr_mod,
         IN              const   uint8_t                                         hop_count,
-        IN              const   ib_net64_t                                      m_key,
+        IN              const   ib_net64_t                                      m_key,
         IN              const   uint8_t*                                        path_out,
-        IN              const   ib_net16_t                                      dr_slid,
-        IN              const   ib_net16_t                                      dr_dlid )
+        IN              const   ib_net16_t                                      dr_slid,
+        IN              const   ib_net16_t                                      dr_dlid )
 {
         CL_ASSERT( p_smp );
-        CL_ASSERT( hop_count < IB_SUBNET_PATH_HOPS_MAX );
+        CL_ASSERT( hop_count < IB_SUBNET_PATH_HOPS_MAX );
         p_smp->base_ver = 1;
-        p_smp->mgmt_class = IB_MCLASS_SUBN_DIR;
+        p_smp->mgmt_class = IB_MCLASS_SUBN_DIR;
         p_smp->class_ver = 1;
         p_smp->method = method;
         p_smp->status = 0;
@@ -9508,14 +9583,14 @@ IBA Base: Types/ib_smp_init_new
         p_smp->dr_slid = dr_slid;
         p_smp->dr_dlid = dr_dlid;
 
-        cl_memclr( p_smp->resv1,
+        cl_memclr( p_smp->resv1,
                         sizeof(p_smp->resv1) +
                         sizeof(p_smp->data) +
                         sizeof(p_smp->initial_path) +
                         sizeof(p_smp->return_path) );
 
         /* copy the path */
-        cl_memcpy( &p_smp->initial_path, path_out,
+        cl_memcpy( &p_smp->initial_path, path_out,
                         sizeof( p_smp->initial_path ) );
 }
 
@@ -9552,12 +9627,12 @@ IBA Base: Types/ib_smp_init_new
       Payload area is initialized to zero.
 

SEE ALSO

-
       ib_mad_t
+
       ib_mad_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_smp_is_d

[top][index]

@@ -9570,9 +9645,9 @@ IBA Base: Types/ib_smp_is_d

SYNOPSIS

AL_INLINE boolean_t AL_API
 ib_smp_is_d(
-        IN              const   ib_smp_t* const                         p_smp )
+        IN              const   ib_smp_t* const                         p_smp )
 {
-        return( (p_smp->status & IB_SMP_DIRECTION) == IB_SMP_DIRECTION );
+        return( (p_smp->status & IB_SMP_DIRECTION) == IB_SMP_DIRECTION );
 }
 

PARAMETERS

@@ -9586,12 +9661,12 @@ IBA Base: Types/ib_smp_is_d
 

SEE ALSO

-
       ib_smp_t
+
       ib_smp_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_smp_is_response

[top][index]

@@ -9604,9 +9679,9 @@ IBA Base: Types/ib_smp_is_response

SYNOPSIS

AL_INLINE boolean_t AL_API
 ib_smp_is_response(
-        IN              const   ib_smp_t* const                         p_smp )
+        IN              const   ib_smp_t* const                         p_smp )
 {
-        return( ib_mad_is_response( (const ib_mad_t*)p_smp ) );
+        return( ib_mad_is_response( (const ib_mad_t*)p_smp ) );
 }
 

PARAMETERS

@@ -9620,12 +9695,12 @@ IBA Base: Types/ib_smp_is_response
 

SEE ALSO

-
       ib_smp_t
+
       ib_smp_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_smp_t

[top][index]

@@ -9644,20 +9719,20 @@ typedef struct _ib_smp uint8_t mgmt_class; uint8_t class_ver; uint8_t method; - ib_net16_t status; + ib_net16_t status; uint8_t hop_ptr; uint8_t hop_count; - ib_net64_t trans_id; - ib_net16_t attr_id; - ib_net16_t resv; - ib_net32_t attr_mod; - ib_net64_t m_key; - ib_net16_t dr_slid; - ib_net16_t dr_dlid; + ib_net64_t trans_id; + ib_net16_t attr_id; + ib_net16_t resv; + ib_net32_t attr_mod; + ib_net64_t m_key; + ib_net16_t dr_slid; + ib_net16_t dr_dlid; uint32_t resv1[7]; uint8_t data[IB_SMP_DATA_SIZE]; - uint8_t initial_path[IB_SUBNET_PATH_HOPS_MAX]; - uint8_t return_path[IB_SUBNET_PATH_HOPS_MAX]; + uint8_t initial_path[IB_SUBNET_PATH_HOPS_MAX]; + uint8_t return_path[IB_SUBNET_PATH_HOPS_MAX]; } PACK_SUFFIX ib_smp_t; #include <complib/cl_packoff.h> @@ -9721,7 +9796,7 @@ typedef struct _ib_smp
-

[Structures] +

[Structures] IBA Base: Types/ib_svc_entries_t

[top][index]

@@ -9736,7 +9811,7 @@ IBA Base: Types/ib_svc_entries_t

typedef struct _ib_svc_entries { #define SVC_ENTRY_COUNT 4 - ib_svc_entry_t service_entry[SVC_ENTRY_COUNT]; + ib_svc_entry_t service_entry[SVC_ENTRY_COUNT]; } PACK_SUFFIX ib_svc_entries_t; #include <complib/cl_packoff.h> @@ -9746,12 +9821,12 @@ typedef struct _ib_svc_entries An array of IO controller service entries.

SEE ALSO

-
 ib_dm_mad_t, ib_svc_entry_t
+
 ib_dm_mad_t, ib_svc_entry_t
 

-

[Structures] +

[Structures] IBA Base: Types/ib_svc_entry_t

[top][index]

@@ -9768,7 +9843,7 @@ typedef struct _ib_svc_entry #define MAX_SVC_ENTRY_NAME_LEN 40 char name[MAX_SVC_ENTRY_NAME_LEN]; - ib_net64_t id; + ib_net64_t id; } PACK_SUFFIX ib_svc_entry_t; #include <complib/cl_packoff.h> @@ -9781,12 +9856,12 @@ typedef struct _ib_svc_entry An identifier of the associated Service.

SEE ALSO

-
 ib_svc_entries_t
+
 ib_svc_entries_t
 

-

[Functions] +

[Functions] IBA Base: Types/ib_switch_info_clear_state_change

[top][index]

@@ -9799,7 +9874,7 @@ IBA Base: Types/ib_switch_info_clear_state_change

SYNOPSIS

AL_INLINE void AL_API
 ib_switch_info_clear_state_change(
-        IN                              ib_switch_info_t* const         p_si )
+        IN                              ib_switch_info_t* const         p_si )
 {
         p_si->life_state = (uint8_t)(p_si->life_state & 0xFB);
 }
@@ -9818,7 +9893,7 @@ IBA Base: Types/ib_switch_info_clear_state_change
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_switch_info_get_state_change

[top][index]

@@ -9831,7 +9906,7 @@ IBA Base: Types/ib_switch_info_get_state_change

SYNOPSIS

AL_INLINE boolean_t AL_API
 ib_switch_info_get_state_change(
-        IN              const   ib_switch_info_t* const         p_si )
+        IN              const   ib_switch_info_t* const         p_si )
 {
         return( (p_si->life_state & IB_SWITCH_PSC) == IB_SWITCH_PSC );
 }
@@ -9850,7 +9925,7 @@ IBA Base: Types/ib_switch_info_get_state_change
 
 
-

[Structures] +

[Structures] IBA Base: Types/ib_switch_info_t

[top][index]

@@ -9864,16 +9939,16 @@ IBA Base: Types/ib_switch_info_t

#include <complib/cl_packon.h>
 typedef struct _ib_switch_info
 {
-        ib_net16_t                      lin_cap;
-        ib_net16_t                      rand_cap;
-        ib_net16_t                      mcast_cap;
-        ib_net16_t                      lin_top;
+        ib_net16_t                      lin_cap;
+        ib_net16_t                      rand_cap;
+        ib_net16_t                      mcast_cap;
+        ib_net16_t                      lin_top;
         uint8_t                         def_port;
         uint8_t                         def_mcast_pri_port;
         uint8_t                         def_mcast_not_port;
         uint8_t                         life_state;
-        ib_net16_t                      lids_per_port;
-        ib_net16_t                      enforce_cap;
+        ib_net16_t                      lids_per_port;
+        ib_net16_t                      enforce_cap;
         uint8_t                         flags;
 
 }       PACK_SUFFIX ib_switch_info_t;
@@ -9882,7 +9957,7 @@ typedef struct _ib_switch_info
 
 
-

[Functions] +

[Functions] IBA Base: Types/ib_vl_arb_element_get_vl

[top][index]

@@ -9895,7 +9970,7 @@ IBA Base: Types/ib_vl_arb_element_get_vl

SYNOPSIS

AL_INLINE uint8_t AL_API
 ib_vl_arb_element_get_vl(
-        IN              const   ib_vl_arb_element_t                     vl_arb_element )
+        IN              const   ib_vl_arb_element_t                     vl_arb_element )
 {
         return (vl_arb_element.res_vl >> 4);
 }
@@ -9908,12 +9983,12 @@ IBA Base: Types/ib_vl_arb_element_get_vl
        Returns the VL value for the specified VL arbitration table element.
 

SEE ALSO

-
       vl_arb_element, ib_vl_arb_element_set_vl
+
       vl_arb_element, ib_vl_arb_element_set_vl
 

-

[Functions] +

[Functions] IBA Base: Types/ib_vl_arb_element_set_vl

[top][index]

@@ -9926,7 +10001,7 @@ IBA Base: Types/ib_vl_arb_element_set_vl

SYNOPSIS

AL_INLINE void AL_API
 ib_vl_arb_element_set_vl(
-        IN      OUT                     ib_vl_arb_element_t* const      p_vl_arb_element,
+        IN      OUT                     ib_vl_arb_element_t* const      p_vl_arb_element,
         IN              const   uint8_t                                         vl )
 {
         p_vl_arb_element->res_vl = vl << 4;
@@ -9943,12 +10018,12 @@ IBA Base: Types/ib_vl_arb_element_set_vl
        This function does not return a value.
 

SEE ALSO

-
       vl_arb_element, ib_vl_arb_element_get_vl
+
       vl_arb_element, ib_vl_arb_element_get_vl
 

-

[Structures] +

[Structures] IBA Base: Types/ib_vl_arb_element_t

[top][index]

@@ -9971,7 +10046,7 @@ typedef struct _ib_vl_arb_element
-

[Structures] +

[Structures] IBA Base: Types/ib_vl_arb_table_record_t

[top][index]

@@ -9985,11 +10060,11 @@ IBA Base: Types/ib_vl_arb_table_record_t

#include <complib/cl_packon.h>
 typedef struct _ib_vl_arb_table_record
 {
-        ib_net16_t                      lid; // for CA: lid of port, for switch lid of port 0
+        ib_net16_t                      lid; // for CA: lid of port, for switch lid of port 0
         uint8_t                         port_num;
         uint8_t                         block_num;
         uint32_t                        reserved;
-        ib_vl_arb_table_t       vl_arb_tbl;
+        ib_vl_arb_table_t       vl_arb_tbl;
 
 }       PACK_SUFFIX ib_vl_arb_table_record_t;
 #include <complib/cl_packoff.h>
@@ -9997,7 +10072,7 @@ typedef struct _ib_vl_arb_table_record
 
 
-

[Structures] +

[Structures] IBA Base: Types/ib_vl_arb_table_t

[top][index]

@@ -10011,7 +10086,7 @@ IBA Base: Types/ib_vl_arb_table_t

#include <complib/cl_packon.h>
 typedef struct _ib_vl_arb_table
 {
-        ib_vl_arb_element_t vl_entry[IB_NUM_VL_ARB_ELEMENTS_IN_BLOCK];
+        ib_vl_arb_element_t vl_entry[IB_NUM_VL_ARB_ELEMENTS_IN_BLOCK];
 
 }       PACK_SUFFIX ib_vl_arb_table_t;
 #include <complib/cl_packoff.h>
@@ -10019,7 +10094,7 @@ typedef struct _ib_vl_arb_table
 
 
-

[Functions] +

[Functions] IBA Base: Types/ioc_at_slot

[top][index]

@@ -10032,7 +10107,7 @@ IBA Base: Types/ioc_at_slot

SYNOPSIS

AL_INLINE uint8_t AL_API
 ioc_at_slot(
-        IN              const   ib_iou_info_t*  const   p_iou_info,
+        IN              const   ib_iou_info_t*  const   p_iou_info,
         IN                              uint8_t                                 slot )
 {
         if( !slot )
@@ -10058,12 +10133,12 @@ IBA Base: Types/ioc_at_slot
 
       The input slot number is 1-based, not zero based.
 

SEE ALSO

-
       ib_iou_info_t
+
       ib_iou_info_t
 

-

[Functions] +

[Functions] IBA Bases: Types/ib_dm_get_slot_lo_hi

[top][index]

@@ -10072,12 +10147,12 @@ IBA Bases: Types/ib_dm_get_slot_lo_hi

service entries given the attribute modifier of ServiceEntries response.

SEE ALSO

-
 ib_dm_set_slot_lo_hi
+
 ib_dm_set_slot_lo_hi
 

-

[Functions] +

[Functions] IBA Bases: Types/ib_dm_set_slot_lo_hi

[top][index]

@@ -10086,12 +10161,12 @@ IBA Bases: Types/ib_dm_set_slot_lo_hi

entries and returns it.

SEE ALSO

-
 ib_dm_get_slot_lo_hi
+
 ib_dm_get_slot_lo_hi
 

-

[Definitions] +

[Definitions] Verbs/ib_async_event_t

[top][parent][index]

@@ -10100,7 +10175,7 @@ Verbs/ib_async_event_t

DESCRIPTION

       This type indicates the reason the async callback was called.
-       The context in the ib_event_rec_t indicates the resource context
+       The context in the ib_event_rec_t indicates the resource context
        that associated with the callback.  For example, for IB_AE_CQ_ERROR
        the context provided during the ib_create_cq is returned in the event.
 
@@ -10229,7 +10304,7 @@ Verbs/ib_async_event_t

-

[Structures] +

[Structures] Verbs/ib_event_rec_t

[top][parent][index]

@@ -10251,7 +10326,7 @@ Verbs/ib_event_rec_t

typedef struct _ib_event_rec
 {
         void* __ptr64                   context;
-        ib_async_event_t                type;
+        ib_async_event_t                type;
 
         /* HCA vendor specific event information. */
         uint64_t                                vendor_specific;
@@ -10262,7 +10337,7 @@ Verbs/ib_event_rec_t
                 struct
                 {
                         uint16_t                        lid;
-                        ib_net64_t                      port_guid;
+                        ib_net64_t                      port_guid;
                         uint8_t                         port_num;
 
                         /*
@@ -10282,14 +10357,14 @@ Verbs/ib_event_rec_t
                                 } key;
                                 uint32_t                src_qp;
                                 uint32_t                dest_qp;
-                                ib_gid_t                src_gid;
-                                ib_gid_t                dest_gid;
+                                ib_gid_t                src_gid;
+                                ib_gid_t                dest_gid;
 
                         }       violation;
 
                 } info;
 
-                ib_net64_t      sysimg_guid;
+                ib_net64_t      sysimg_guid;
 
         }       trap;
 
diff --git a/trunk/docs/kernel/complib/cl_bus_ifc_h.html b/trunk/docs/kernel/complib/cl_bus_ifc_h.html
index 960f8c45..d4c943ef 100644
--- a/trunk/docs/kernel/complib/cl_bus_ifc_h.html
+++ b/trunk/docs/kernel/complib/cl_bus_ifc_h.html
@@ -2,16 +2,16 @@
 
 
 
-./inc_doc/kernel/complib/cl_bus_ifc_h.html
+./inc_docs/kernel/complib/cl_bus_ifc_h.html
 
 
 
 
-Generated from ./inc/kernel/complib/cl_bus_ifc.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31
+Generated from ./inc/kernel/complib/cl_bus_ifc.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39
 

-

[Functions] +

[Functions] Component Library: Plug and Play/cl_fwd_query_ifc

[top][index]

diff --git a/trunk/docs/kernel/complib/cl_pnp_po_h.html b/trunk/docs/kernel/complib/cl_pnp_po_h.html index 6fcb2e4a..6ca20922 100644 --- a/trunk/docs/kernel/complib/cl_pnp_po_h.html +++ b/trunk/docs/kernel/complib/cl_pnp_po_h.html @@ -2,19 +2,19 @@ -./inc_doc/kernel/complib/cl_pnp_po_h.html +./inc_docs/kernel/complib/cl_pnp_po_h.html -Generated from ./inc/kernel/complib/cl_pnp_po.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/kernel/complib/cl_pnp_po.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

[Modules] Component Library/Plug and Play

-

[top][index]

+

[top][parent][index]

NAME

       Plug and Play
 
@@ -23,7 +23,7 @@ Component Library/Plug and Play

SEE ALSO

       Callback Types:
-               cl_pfn_pnp_po_t
+               cl_pfn_pnp_po_t
 
        Structures:
                cl_vfptr_pnp_t
@@ -31,7 +31,7 @@ Component Library/Plug and Play
 
 
-

[Functions] +

[Functions] Component Library: Plug and Play/cl_alloc_relations

[top][index]

@@ -72,7 +72,7 @@ Component Library: Plug and Play/cl_alloc_relations


-

[Functions] +

[Functions] Component Library: Plug and Play/cl_do_remove

[top][index]

@@ -88,12 +88,12 @@ Component Library: Plug and Play/cl_do_remove

cl_do_remove( IN DEVICE_OBJECT* const pDevObj, IN IRP* const pIrp, - OUT cl_irp_action_t* const pAction ); + OUT cl_irp_action_t* const pAction );

-

[Functions] +

[Functions] Component Library: Plug and Play/cl_do_sync_pnp

[top][index]

@@ -110,7 +110,7 @@ Component Library: Plug and Play/cl_do_sync_pnp

cl_do_sync_pnp( IN DEVICE_OBJECT* const p_dev_obj, IN IRP* const p_irp, - OUT cl_irp_action_t* const p_action ); + OUT cl_irp_action_t* const p_action ); /* * PARAMETER * p_dev_obj @@ -128,7 +128,7 @@ Component Library: Plug and Play/cl_do_sync_pnp
-

[Functions] +

[Functions] Component Library: Plug and Play/cl_init_pnp_po_ext

[top][index]

@@ -145,7 +145,7 @@ Component Library: Plug and Play/cl_init_pnp_po_ext

IN DEVICE_OBJECT* const p_next_do, IN DEVICE_OBJECT* const p_pdo, IN const uint32_t pnp_po_dbg_lvl, - IN const cl_vfptr_pnp_po_t* const vfptr_pnp, + IN const cl_vfptr_pnp_po_t* const vfptr_pnp, IN const cl_vfptr_query_txt_t* const vfptr_query_txt OPTIONAL );

PARAMETERS

@@ -170,12 +170,12 @@ Component Library: Plug and Play/cl_init_pnp_po_ext Pointer to the function table for IRP_MN_QUERY_DEVICE_TEXT handlers.

SEE ALSO

-
       Plug and Play, cl_pnp_po_ext_t, cl_vfptr_pnp_po_t, cl_vfptr_query_txt_t
+
       Plug and Play, cl_pnp_po_ext_t, cl_vfptr_pnp_po_t, cl_vfptr_query_txt_t
 

-

[Definitions] +

[Definitions] Component Library: Plug and Play/cl_irp_action_t

[top][index]

@@ -212,7 +212,7 @@ Component Library: Plug and Play/cl_irp_action_t


-

[Definitions] +

[Definitions] Component Library: Plug and Play/cl_pfn_pnp_po_t

[top][index]

@@ -227,7 +227,7 @@ Component Library: Plug and Play/cl_pfn_pnp_po_t

(*cl_pfn_pnp_po_t)( IN DEVICE_OBJECT* const p_dev_obj, IN IRP* const p_irp, - OUT cl_irp_action_t* const p_action ); + OUT cl_irp_action_t* const p_action );

PARAMETERS

       p_dev_obj
@@ -243,12 +243,12 @@ Component Library: Plug and Play/cl_pfn_pnp_po_t
        IRP status value.
 

SEE ALSO

-
       Plug and Play, cl_irp_action_t, cl_vfptr_pnp_po_t
+
       Plug and Play, cl_irp_action_t, cl_vfptr_pnp_po_t
 

-

[Definitions] +

[Definitions] Component Library: Plug and Play/cl_pfn_query_text_t

[top][index]

@@ -284,7 +284,7 @@ Component Library: Plug and Play/cl_pfn_query_text_t


-

[Definitions] +

[Definitions] Component Library: Plug and Play/cl_pfn_release_resources_t

[top][index]

@@ -308,12 +308,12 @@ Component Library: Plug and Play/cl_pfn_release_resources_t

This function does not return a value.

SEE ALSO

-
       Plug and Play, cl_vfptr_pnp_po_t
+
       Plug and Play, cl_vfptr_pnp_po_t
 

-

[Definitions] +

[Definitions] Component Library: Plug and Play/cl_pnp_po_ext_t

[top][index]

@@ -327,8 +327,8 @@ Component Library: Plug and Play/cl_pnp_po_ext_t

SYNOPSIS

typedef struct _cl_pnp_po_ext
 {
-        cl_pnp_state_t                          pnp_state;
-        cl_pnp_state_t                          last_pnp_state;
+        cl_pnp_state_t                          pnp_state;
+        cl_pnp_state_t                          last_pnp_state;
 
         DEVICE_OBJECT                           *p_self_do;
         DEVICE_OBJECT                           *p_next_do;
@@ -341,7 +341,7 @@ Component Library: Plug and Play/cl_pnp_po_ext_t
         atomic32_t                                      n_crash_files;
         atomic32_t                                      n_hibernate_files;
 
-        const cl_vfptr_pnp_po_t         *vfptr_pnp_po;
+        const cl_vfptr_pnp_po_t         *vfptr_pnp_po;
         const cl_vfptr_query_txt_t      *vfptr_query_txt;
 
         void                                            *h_cl_locked_section;
@@ -402,12 +402,12 @@ Component Library: Plug and Play/cl_pnp_po_ext_t
        functions respectively.
 

SEE ALSO

-
       Plug and Play, cl_vfptr_pnp_po_t, cl_pnp_state_t, cl_start_io, cl_end_io
+
       Plug and Play, cl_vfptr_pnp_po_t, cl_pnp_state_t, cl_start_io, cl_end_io
 

-

[Definitions] +

[Definitions] Component Library: Plug and Play/cl_pnp_state_t

[top][index]

@@ -457,12 +457,12 @@ Component Library: Plug and Play/cl_pnp_state_t

Unknown state

SEE ALSO

-
       Plug and Play, cl_pnp_po_ext_t
+
       Plug and Play, cl_pnp_po_ext_t
 

-

[Functions] +

[Functions] Component Library: Plug and Play/cl_rollback_pnp_state

[top][index]

@@ -475,7 +475,7 @@ Component Library: Plug and Play/cl_rollback_pnp_state

SYNOPSIS

CL_INLINE void
 cl_rollback_pnp_state(
-                OUT                     cl_pnp_po_ext_t* const          p_ext )
+                OUT                     cl_pnp_po_ext_t* const          p_ext )
 {
         p_ext->pnp_state = p_ext->last_pnp_state;
 }
@@ -488,12 +488,12 @@ Component Library: Plug and Play/cl_rollback_pnp_state
 *       This function does not return a value.
 

SEE ALSO

-
       Plug and Play, cl_pnp_po_ext_t
+
       Plug and Play, cl_pnp_po_ext_t
 

-

[Functions] +

[Functions] Component Library: Plug and Play/cl_set_pnp_state

[top][index]

@@ -507,8 +507,8 @@ Component Library: Plug and Play/cl_set_pnp_state

SYNOPSIS

CL_INLINE void
 cl_set_pnp_state(
-                OUT                     cl_pnp_po_ext_t* const          p_ext,
-        IN              const   cl_pnp_state_t                          new_state )
+                OUT                     cl_pnp_po_ext_t* const          p_ext,
+        IN              const   cl_pnp_state_t                          new_state )
 {
         p_ext->last_pnp_state = p_ext->pnp_state;
         p_ext->pnp_state = new_state;
@@ -525,12 +525,12 @@ Component Library: Plug and Play/cl_set_pnp_state
 *       This function does not return a value.
 

SEE ALSO

-
       Plug and Play, cl_pnp_po_ext_t, cl_pnp_state_t
+
       Plug and Play, cl_pnp_po_ext_t, cl_pnp_state_t
 

-

[Definitions] +

[Definitions] Component Library: Plug and Play/cl_vfptr_pnp_po_t

[top][index]

@@ -544,36 +544,36 @@ Component Library: Plug and Play/cl_vfptr_pnp_po_t

typedef struct _cl_vfptr_pnp_po
 {
         const char*                                             identity;
-        cl_pfn_pnp_po_t                                 pfn_start;
-        cl_pfn_pnp_po_t                                 pfn_query_stop;
-        cl_pfn_pnp_po_t                                 pfn_stop;
-        cl_pfn_pnp_po_t                                 pfn_cancel_stop;
-        cl_pfn_pnp_po_t                                 pfn_query_remove;
-        cl_pfn_release_resources_t              pfn_release_resources;
-        cl_pfn_pnp_po_t                                 pfn_remove;
-        cl_pfn_pnp_po_t                                 pfn_cancel_remove;
-        cl_pfn_pnp_po_t                                 pfn_surprise_remove;
-        cl_pfn_pnp_po_t                                 pfn_query_capabilities;
-        cl_pfn_pnp_po_t                                 pfn_query_pnp_state;
-        cl_pfn_pnp_po_t                                 pfn_filter_res_req;
-        cl_pfn_pnp_po_t                                 pfn_dev_usage_notification;
-        cl_pfn_pnp_po_t                                 pfn_query_bus_relations;
-        cl_pfn_pnp_po_t                                 pfn_query_ejection_relations;
-        cl_pfn_pnp_po_t                                 pfn_query_removal_relations;
-        cl_pfn_pnp_po_t                                 pfn_query_target_relations;
-        cl_pfn_pnp_po_t                                 pfn_unknown;
-        cl_pfn_pnp_po_t                                 pfn_query_resources;
-        cl_pfn_pnp_po_t                                 pfn_query_res_req;
-        cl_pfn_pnp_po_t                                 pfn_query_bus_info;
-        cl_pfn_pnp_po_t                                 pfn_query_interface;
-        cl_pfn_pnp_po_t                                 pfn_read_config;
-        cl_pfn_pnp_po_t                                 pfn_write_config;
-        cl_pfn_pnp_po_t                                 pfn_eject;
-        cl_pfn_pnp_po_t                                 pfn_set_lock;
-        cl_pfn_pnp_po_t                                 pfn_query_power;
-        cl_pfn_pnp_po_t                                 pfn_set_power;
-        cl_pfn_pnp_po_t                                 pfn_power_sequence;
-        cl_pfn_pnp_po_t                                 pfn_wait_wake;
+        cl_pfn_pnp_po_t                                 pfn_start;
+        cl_pfn_pnp_po_t                                 pfn_query_stop;
+        cl_pfn_pnp_po_t                                 pfn_stop;
+        cl_pfn_pnp_po_t                                 pfn_cancel_stop;
+        cl_pfn_pnp_po_t                                 pfn_query_remove;
+        cl_pfn_release_resources_t              pfn_release_resources;
+        cl_pfn_pnp_po_t                                 pfn_remove;
+        cl_pfn_pnp_po_t                                 pfn_cancel_remove;
+        cl_pfn_pnp_po_t                                 pfn_surprise_remove;
+        cl_pfn_pnp_po_t                                 pfn_query_capabilities;
+        cl_pfn_pnp_po_t                                 pfn_query_pnp_state;
+        cl_pfn_pnp_po_t                                 pfn_filter_res_req;
+        cl_pfn_pnp_po_t                                 pfn_dev_usage_notification;
+        cl_pfn_pnp_po_t                                 pfn_query_bus_relations;
+        cl_pfn_pnp_po_t                                 pfn_query_ejection_relations;
+        cl_pfn_pnp_po_t                                 pfn_query_removal_relations;
+        cl_pfn_pnp_po_t                                 pfn_query_target_relations;
+        cl_pfn_pnp_po_t                                 pfn_unknown;
+        cl_pfn_pnp_po_t                                 pfn_query_resources;
+        cl_pfn_pnp_po_t                                 pfn_query_res_req;
+        cl_pfn_pnp_po_t                                 pfn_query_bus_info;
+        cl_pfn_pnp_po_t                                 pfn_query_interface;
+        cl_pfn_pnp_po_t                                 pfn_read_config;
+        cl_pfn_pnp_po_t                                 pfn_write_config;
+        cl_pfn_pnp_po_t                                 pfn_eject;
+        cl_pfn_pnp_po_t                                 pfn_set_lock;
+        cl_pfn_pnp_po_t                                 pfn_query_power;
+        cl_pfn_pnp_po_t                                 pfn_set_power;
+        cl_pfn_pnp_po_t                                 pfn_power_sequence;
+        cl_pfn_pnp_po_t                                 pfn_wait_wake;
 
 }       cl_vfptr_pnp_po_t;
 
@@ -638,7 +638,7 @@ Component Library: Plug and Play/cl_vfptr_pnp_po_t pfn_unknown FDO and Filter drivers should pass this IRP down. Bus drivers should complete the request for their PDOs without modifying the status. - The component library provides the cl_irp_skip and cl_irp_complete + The component library provides the cl_irp_skip and cl_irp_complete functions to skip and complete and IRP, respectively. These functions can be used to perform the required action. This handler is invoked when an undocumented PNP irp is received. @@ -683,7 +683,7 @@ Component Library: Plug and Play/cl_vfptr_pnp_po_t
       The component library provides default handlers for skiping the IRP,
        completing the IRP without changing the status, and processing the IRP
        on the way up the device stack.  Users can set the handler to 
-       cl_irp_skip, cl_irp_complete, cl_do_sync_pnp.
+       cl_irp_skip, cl_irp_complete, cl_do_sync_pnp.
 
        The handlers specified in pfn_query_power, pfn_set_power, 
        pfn_power_sequence, and pfn_wait_wake, if implemented as pageable code,
@@ -692,13 +692,13 @@ Component Library: Plug and Play/cl_vfptr_pnp_po_t
        lock down the user's power management code.
 

SEE ALSO

-
       Plug and Play, cl_pfn_pnp_po_t, cl_pfn_release_resources_t, cl_do_sync_pnp,
-       cl_irp_skip, cl_irp_complete, cl_irp_unsupported, cl_irp_fail
+
       Plug and Play, cl_pfn_pnp_po_t, cl_pfn_release_resources_t, cl_do_sync_pnp,
+       cl_irp_skip, cl_irp_complete, cl_irp_unsupported, cl_irp_fail
 

-

[Definitions] +

[Definitions] Component Library: Plug and Play/cl_vfptr_query_txt

[top][index]

@@ -712,12 +712,12 @@ Component Library: Plug and Play/cl_vfptr_query_txt

SYNOPSIS

typedef struct _cl_vfptr_query_txt
 {
-        cl_pfn_query_text_t             pfn_query_device_id;
-        cl_pfn_query_text_t             pfn_query_hardware_id;
-        cl_pfn_query_text_t             pfn_query_compatible_id;
-        cl_pfn_query_text_t             pfn_query_unique_id;
-        cl_pfn_query_text_t             pfn_query_description;
-        cl_pfn_query_text_t             pfn_query_location;
+        cl_pfn_query_text_t             pfn_query_device_id;
+        cl_pfn_query_text_t             pfn_query_hardware_id;
+        cl_pfn_query_text_t             pfn_query_compatible_id;
+        cl_pfn_query_text_t             pfn_query_unique_id;
+        cl_pfn_query_text_t             pfn_query_description;
+        cl_pfn_query_text_t             pfn_query_location;
 
 }       cl_vfptr_query_txt_t;
 
@@ -749,12 +749,12 @@ Component Library: Plug and Play/cl_vfptr_query_txt the table since they typically do not handle these requests.

SEE ALSO

-
       Plug and Play, cl_pfn_query_text_t
+
       Plug and Play, cl_pfn_query_text_t
 

-

[Functions] +

[Functions] Component Library: Plug and Play:/cl_irp_complete

[top][index]

@@ -771,7 +771,7 @@ Component Library: Plug and Play:/cl_irp_complete

cl_irp_complete( IN DEVICE_OBJECT* const p_dev_obj, IN IRP* const p_irp, - OUT cl_irp_action_t* const p_action ); + OUT cl_irp_action_t* const p_action );

PARAMETERS

       p_dev_obj
@@ -787,12 +787,12 @@ Component Library: Plug and Play:/cl_irp_complete
        IRP status value.
 

SEE ALSO

-
       Plug and Play, cl_irp_action_t, cl_vfptr_pnp_po_t
+
       Plug and Play, cl_irp_action_t, cl_vfptr_pnp_po_t
 

-

[Functions] +

[Functions] Component Library: Plug and Play:/cl_irp_ignore

[top][index]

@@ -802,14 +802,14 @@ Component Library: Plug and Play:/cl_irp_ignore

DESCRIPTION

       Default function for skipping a PnP IRP without setting the IRP's status.
        Useable only by function and filter drivers.  Bus drivers should use 
-       cl_irp_complete for their PDOs to complete an IRP with no change in status.
+       cl_irp_complete for their PDOs to complete an IRP with no change in status.
 

SYNOPSIS

CL_EXPORT NTSTATUS
 cl_irp_ignore(
         IN                              DEVICE_OBJECT* const            p_dev_obj,
         IN                              IRP* const                                      p_irp, 
-                OUT                     cl_irp_action_t* const          p_action );
+                OUT                     cl_irp_action_t* const          p_action );
 

PARAMETERS

       p_dev_obj
@@ -825,12 +825,12 @@ Component Library: Plug and Play:/cl_irp_ignore
        IRP status value.
 

SEE ALSO

-
       Plug and Play, cl_irp_action_t
+
       Plug and Play, cl_irp_action_t
 

-

[Functions] +

[Functions] Component Library: Plug and Play:/cl_irp_skip

[top][index]

@@ -840,14 +840,14 @@ Component Library: Plug and Play:/cl_irp_skip

DESCRIPTION

       Default function for skipping a PnP IRP.  Sets the IRP's status value.
        Useable only by function and filter drivers.  Bus drivers should use 
-       cl_irp_complete for their PDOs to complete an IRP with no change in status.
+       cl_irp_complete for their PDOs to complete an IRP with no change in status.
 

SYNOPSIS

CL_EXPORT NTSTATUS
 cl_irp_skip(
         IN                              DEVICE_OBJECT* const            p_dev_obj,
         IN                              IRP* const                                      p_irp, 
-                OUT                     cl_irp_action_t* const          p_action );
+                OUT                     cl_irp_action_t* const          p_action );
 

PARAMETERS

       p_dev_obj
@@ -863,12 +863,12 @@ Component Library: Plug and Play:/cl_irp_skip
        IRP status value.
 

SEE ALSO

-
       Plug and Play, cl_irp_action_t
+
       Plug and Play, cl_irp_action_t
 

-

[Functions] +

[Functions] Component Library: Plug and Play:/cl_irp_succeed

[top][index]

@@ -883,7 +883,7 @@ Component Library: Plug and Play:/cl_irp_succeed

cl_irp_succeed( IN DEVICE_OBJECT* const p_dev_obj, IN IRP* const p_irp, - OUT cl_irp_action_t* const p_action ); + OUT cl_irp_action_t* const p_action );

PARAMETERS

       p_dev_obj
@@ -899,12 +899,12 @@ Component Library: Plug and Play:/cl_irp_succeed
        IRP status value.
 

SEE ALSO

-
       Plug and Play, cl_irp_action_t
+
       Plug and Play, cl_irp_action_t
 

-

[Functions] +

[Functions] Component Library: Plug and Play:/cl_irp_unsupported

[top][index]

@@ -919,7 +919,7 @@ Component Library: Plug and Play:/cl_irp_unsupported

cl_irp_unsupported( IN DEVICE_OBJECT* const p_dev_obj, IN IRP* const p_irp, - OUT cl_irp_action_t* const p_action ); + OUT cl_irp_action_t* const p_action );

PARAMETERS

       p_dev_obj
@@ -935,12 +935,12 @@ Component Library: Plug and Play:/cl_irp_unsupported
        IRP status value.
 

SEE ALSO

-
       Plug and Play, cl_irp_action_t
+
       Plug and Play, cl_irp_action_t
 

-

[Functions] +

[Functions] Component Library: Plug and Play:/cl_pnp

[top][index]

@@ -974,7 +974,7 @@ Component Library: Plug and Play:/cl_pnp


-

[Functions] +

[Functions] Component Library: Plug and Play:/cl_power

[top][index]

diff --git a/trunk/docs/kernel/iba/ib_al_ifc_h.html b/trunk/docs/kernel/iba/ib_al_ifc_h.html index 56d9cfcc..47f955de 100644 --- a/trunk/docs/kernel/iba/ib_al_ifc_h.html +++ b/trunk/docs/kernel/iba/ib_al_ifc_h.html @@ -2,21 +2,21 @@ -./inc_doc/kernel/iba/ib_al_ifc_h.html +./inc_docs/kernel/iba/ib_al_ifc_h.html -Generated from ./inc/kernel/iba/ib_al_ifc.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/kernel/iba/ib_al_ifc.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] -Access Layer/ib_al_ifc.h

+

[Modules] +Access Layer/AL Interface

-

[top][index]

+

[top][parent][index]

NAME

-
       ib_al_ifc.h
+
       AL Interface
 

DESCRIPTION

       Header file for the interface exported to ICT client drivers for access to
diff --git a/trunk/docs/kernel/iba/ib_ci_ifc_h.html b/trunk/docs/kernel/iba/ib_ci_ifc_h.html
index c0f95217..ab039ce4 100644
--- a/trunk/docs/kernel/iba/ib_ci_ifc_h.html
+++ b/trunk/docs/kernel/iba/ib_ci_ifc_h.html
@@ -2,26 +2,71 @@
 
 
 
-./inc_doc/kernel/iba/ib_ci_ifc_h.html
+./inc_docs/kernel/iba/ib_ci_ifc_h.html
 
 
 
 
-Generated from ./inc/kernel/iba/ib_ci_ifc.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31
+Generated from ./inc/kernel/iba/ib_ci_ifc.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38
 

-

[Modules] -Access Layer/ib_ci_ifc.h

+

[Modules] +Access Layer/AL Channel Interface

-

[top][index]

+

[top][parent][index]

NAME

-
       ib_ci_ifc.h
+
       AL Channel Interface
 

DESCRIPTION

       Header file for the interface exported to HCA drivers to allow them
        to register with AL for use by AL clients.
 
+
+ +

[Structures] +Access Layer: AL Channel Interface/ib_ci_ifc_t

+ +

[top][index]

+

NAME

+
       ib_ci_ifc_t
+
+

DESCRIPTION

+
       
+
+

SYNOPSIS

+
typedef struct _ib_ci_ifc
+{
+
+        INTERFACE                               wdm;
+
+        ib_pfn_register_ca_t    register_ca;
+        ib_pfn_deregister_ca_t  deregister_ca;
+        ib_pfn_get_relations_t  get_relations;
+        ib_pfn_get_err_str_t    get_err_str;
+
+}       ib_ci_ifc_t;
+
+

FIELDS

+
       wdmr.
+               Standard interface header.
+
+       register_ca
+               Pointer  to ib_pfn_register_ca_t function
+
+       deregister_ca
+               Pointer  to ib_pfn_deregister_ca_t function
+
+       get_relations
+               Pointer  to ib_pfn_get_relations_t function
+
+       get_err_str
+               Pointer  to ib_pfn_get_err_str_t function
+
+

SEE ALSO

+
       ib_register_ca,ib_deregister_ca,
+
+
diff --git a/trunk/docs/kernel/iba/ioc_ifc_h.html b/trunk/docs/kernel/iba/ioc_ifc_h.html index b0506727..65e661b1 100644 --- a/trunk/docs/kernel/iba/ioc_ifc_h.html +++ b/trunk/docs/kernel/iba/ioc_ifc_h.html @@ -2,21 +2,21 @@ -./inc_doc/kernel/iba/ioc_ifc_h.html +./inc_docs/kernel/iba/ioc_ifc_h.html -Generated from ./inc/kernel/iba/ioc_ifc.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:30 +Generated from ./inc/kernel/iba/ioc_ifc.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] -Access Layer/ioc_ifc.h

+

[Modules] +Access Layer/IO Controler Interface

-

[top][index]

+

[top][parent][index]

NAME

-
       ioc_ifc.h
+
       IO Controler Interface
 

DESCRIPTION

       Header file for the interface exported to IOC client drivers to retrieve
@@ -25,5 +25,38 @@ Access Layer/ioc_ifc.h
        The interface contains information about the particular instance of an IOC.
 
+
+ +

[Structures] +Access Layer: IO Controler Interface/ioc_ifc_data_t

+ +

[top][index]

+

NAME

+
       ioc_ifc_data_t
+
+

DESCRIPTION

+
       I/O Controler interface data.
+
+       The ioc_ifc_data_t structure 
+
+

SYNOPSIS

+
typedef struct _ioc_ifc_data
+{
+        net64_t                                 ca_guid;
+        net64_t                                 guid;
+
+}       ioc_ifc_data_t;
+
+

FIELDS

+
       ca_guid
+               Local CA GUID through which IOC is accessible.
+
+       guid
+               IOC GUID.
+
+

SEE ALSO

+
       
+
+
diff --git a/trunk/docs/kernel/iba/iou_ifc_h.html b/trunk/docs/kernel/iba/iou_ifc_h.html index dab07ad2..548436e8 100644 --- a/trunk/docs/kernel/iba/iou_ifc_h.html +++ b/trunk/docs/kernel/iba/iou_ifc_h.html @@ -2,21 +2,21 @@ -./inc_doc/kernel/iba/iou_ifc_h.html +./inc_docs/kernel/iba/iou_ifc_h.html -Generated from ./inc/kernel/iba/iou_ifc.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:30 +Generated from ./inc/kernel/iba/iou_ifc.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] -Access Layer/iou_ifc.h

+

[Modules] +Access Layer/ IO Unit Interface

-

[top][index]

+

[top][parent][index]

NAME

-
       iou_ifc.h
+
       IO Unit Interface
 

DESCRIPTION

       Header file for the interface exported to IOU client drivers to retrieve
@@ -25,5 +25,46 @@ Access Layer/iou_ifc.h
        The interface contains information about the particular instance of an IOU.
 
+
+ +

[Structures] +Access Layer: IO Unit Interface/iou_ifc_data_t

+ +

[top][index]

+

NAME

+
       iou_ifc_data_t
+
+

DESCRIPTION

+
       I/O Unit interface data.
+
+       The iou_ifc_data_t structure 
+
+

SYNOPSIS

+
typedef struct _iou_ifc_data
+{
+        net64_t                                 ca_guid;
+        net64_t                                 chassis_guid;
+        uint8_t                                 slot;
+        net64_t                                 guid;
+
+}       iou_ifc_data_t;
+
+

FIELDS

+
       ca_guid
+               Local CA GUID through which IOU is accessible.
+
+       chassis_guid
+               IOU chassis GUID.
+
+       slot
+               IOU  slot.
+
+       guid
+               IOU  GUID.
+
+

SEE ALSO

+
       
+
+
diff --git a/trunk/docs/kernel/iba/ipoib_ifc_h.html b/trunk/docs/kernel/iba/ipoib_ifc_h.html index 69bf2c20..1d49c89f 100644 --- a/trunk/docs/kernel/iba/ipoib_ifc_h.html +++ b/trunk/docs/kernel/iba/ipoib_ifc_h.html @@ -2,21 +2,21 @@ -./inc_doc/kernel/iba/ipoib_ifc_h.html +./inc_docs/kernel/iba/ipoib_ifc_h.html -Generated from ./inc/kernel/iba/ipoib_ifc.h with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:30 +Generated from ./inc/kernel/iba/ipoib_ifc.h with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:38

-

[Modules] -Access Layer/ipoib_ifc.h

+

[Modules] +Access Layer/IPoIB Interface

-

[top][index]

+

[top][parent][index]

NAME

-
       ipoib_ifc.h
+
       IPoIB Interface
 

DESCRIPTION

       Header file for the interface exported to IPoIB client drivers for access
@@ -26,5 +26,42 @@ Access Layer/ipoib_ifc.h
        particular instance of an IPoIB device.
 
+
+ +

[Structures] +Access Layer: IPoIB Interface/ipoib_ifc_data_t

+ +

[top][index]

+

NAME

+
       ipoib_ifc_data_t
+
+

DESCRIPTION

+
       IPoIB interface datat.
+
+       The ipoib_ifc_data_t structure 
+
+

SYNOPSIS

+
typedef struct _ipoib_ifc_data
+{
+        net64_t                                         ca_guid;
+        net64_t                                         port_guid;
+        uint8_t                                         port_num;
+
+}       ipoib_ifc_data_t;
+
+

FIELDS

+
       ca_guid
+               HCA GUID for this IPoIB interface
+
+       port_guid
+               Port GUID for this IPoIB interface
+
+       port_num
+               Port Number GUID for this IPoIB interface
+
+

SEE ALSO

+
       
+
+
diff --git a/trunk/docs/masterindex.html b/trunk/docs/masterindex.html index 3456586b..40274c40 100644 --- a/trunk/docs/masterindex.html +++ b/trunk/docs/masterindex.html @@ -7,7 +7,7 @@ -Generated from ./inc/ with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/ with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

[Sourcefiles] @@ -20,2890 +20,2922 @@

Index

- + - + + + + + + + + - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - - - + - + + - + + - - + + - - - - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - - + - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - - + + - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + + - - - + + - - - + + - + + + - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - + - - - + - + - - + + - + + + + + +IPoIB Interface - + - - + - - - + + - - - + + - + + - - - + + - - + + - - - - - + + - - - - - + - - - + - - - + - - - + - - - + - - - + - - + @@ -2912,364 +2944,371 @@ Thread Pool Timer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - + - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + + + - - + + + diff --git a/trunk/docs/robo_definitions.html b/trunk/docs/robo_definitions.html index e7ccd730..5b1e169f 100644 --- a/trunk/docs/robo_definitions.html +++ b/trunk/docs/robo_definitions.html @@ -7,7 +7,7 @@ -Generated from ./inc/ with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/ with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

[Sourcefiles] @@ -20,191 +20,191 @@

Definitions

+ + IO Unit Interface 64-bit Print Format + +Access Layer
+AL Channel Interface +AL Interface +arp_pkt_t
Asynchronous Processor + Atomic Operations +ATS
-ATS + Byte Swapping + ci_alloc_mlnx_fmr +ci_allocate_pd
-ci_allocate_pd + ci_async_event_cb_t + ci_attach_mcast +ci_bind_mw
-ci_bind_mw + ci_close_ca + ci_completion_cb_t +ci_create_av
-ci_create_av + ci_create_cq + ci_create_mw +ci_create_qp
-ci_create_qp + ci_create_spl_qp + ci_dealloc_mlnx_fmr +ci_deallocate_pd
-ci_deallocate_pd + ci_deregister_mr + ci_destroy_av +ci_destroy_cq
-ci_destroy_cq + ci_destroy_mw + ci_destroy_qp +ci_detach_mcast
-ci_detach_mcast + ci_enable_cq_notify + ci_enable_ncomp_cq_notify +ci_interface_t
-ci_interface_t + ci_local_mad + ci_map_phys_mlnx_fmr +ci_modify_av
-ci_modify_av + ci_modify_ca + ci_modify_mr +ci_modify_pmr
-ci_modify_pmr + ci_modify_qp + ci_open_ca +ci_peek_cq
-ci_peek_cq + ci_poll_cq + ci_post_recv +ci_post_send
-ci_post_send + ci_query_av + ci_query_ca +ci_query_cq
-ci_query_cq + ci_query_mr + ci_query_mw +ci_query_qp
-ci_query_qp + ci_register_mr + ci_register_pmr +ci_register_smr
-ci_register_smr + ci_resize_cq + ci_um_close_ca_t +ci_um_open_ca
-ci_um_open_ca + ci_umv_buf_t + ci_unmap_mlnx_fmr +ci_vendor_call
-ci_vendor_call + cl_alloc_relations + cl_async_proc.h +cl_async_proc_construct
-cl_async_proc_construct + cl_async_proc_destroy + cl_async_proc_init +cl_async_proc_item_t
-cl_async_proc_item_t + cl_async_proc_queue + cl_async_proc_t +cl_atomic.h
-cl_atomic.h + cl_atomic_add + cl_atomic_comp_xchg +cl_atomic_dec
-cl_atomic_dec + cl_atomic_inc + cl_atomic_sub +cl_atomic_xchg
-cl_atomic_xchg + cl_break + cl_bus_ifc.h +cl_byteswap.h
-cl_byteswap.h + cl_check_for_read + cl_check_for_write +cl_comppool.h
-cl_comppool.h + cl_copy_from_user + cl_copy_to_user +cl_cpool_construct
-cl_cpool_construct + cl_cpool_count + cl_cpool_destroy +cl_cpool_get
-cl_cpool_get + cl_cpool_grow + cl_cpool_init +cl_cpool_put
-cl_cpool_put + cl_cpool_t + cl_dbg_out +cl_debug.h
-cl_debug.h + cl_destroy_type_t + cl_do_remove +cl_do_sync_pnp
-cl_do_sync_pnp + CL_ENTER + cl_event.h +cl_event_construct
-cl_event_construct + cl_event_destroy + cl_event_init +cl_event_reset
-cl_event_reset + cl_event_signal + cl_event_wait_on +CL_EXIT
-CL_EXIT + cl_fleximap.h + cl_fmap_apply_func +cl_fmap_count
-cl_fmap_count + cl_fmap_delta + cl_fmap_end +cl_fmap_get
-cl_fmap_get + cl_fmap_head + cl_fmap_init +cl_fmap_insert
-cl_fmap_insert + cl_fmap_item_t + cl_fmap_key +cl_fmap_merge
-cl_fmap_merge + cl_fmap_next + cl_fmap_prev +cl_fmap_remove
-cl_fmap_remove + cl_fmap_remove_all + cl_fmap_remove_item +cl_fmap_t
-cl_fmap_t + cl_fmap_tail + cl_free +cl_fwd_query_ifc
-cl_fwd_query_ifc + cl_get_pagesize + cl_get_physaddr +cl_get_tick_count
-cl_get_tick_count + cl_get_tick_freq + cl_get_time_stamp +cl_get_time_stamp_sec
-cl_get_time_stamp_sec + cl_get_time_stamp_usec + +cl_hton16 CL_HTON16
-cl_hton16 -CL_HTON32 + cl_hton32 +CL_HTON32 +cl_hton64
-cl_hton64 + CL_HTON64 + cl_init_pnp_po_ext +cl_ioctl.h
-cl_ioctl.h + cl_ioctl_cmd + cl_ioctl_complete +cl_ioctl_ctl_code
-cl_ioctl_ctl_code + cl_ioctl_handle_t + cl_ioctl_in_buf +cl_ioctl_in_size
-cl_ioctl_in_size + cl_ioctl_out_buf + cl_ioctl_out_size +cl_ioctl_process
-cl_ioctl_process + cl_ioctl_request + cl_ioctl_result +cl_ioctl_type
-cl_ioctl_type + cl_irp_action_t + cl_irp_complete +cl_irp_ignore
-cl_irp_ignore + cl_irp_skip + cl_irp_succeed +cl_irp_unsupported
-cl_irp_unsupported + cl_irqlock.h + cl_irqlock_acquire +cl_irqlock_construct
-cl_irqlock_construct + cl_irqlock_destroy + cl_irqlock_init +cl_irqlock_release
-cl_irqlock_release + cl_is_blockable + cl_is_cpool_inited +cl_is_fmap_empty
-cl_is_fmap_empty + cl_is_item_in_qlist + cl_is_list_empty +cl_is_list_inited
-cl_is_list_inited + cl_is_map_empty + cl_is_map_inited +cl_is_object_in_list
-cl_is_object_in_list + cl_is_pool_inited + cl_is_qcpool_inited +cl_is_qlist_empty
-cl_is_qlist_empty + cl_is_qmap_empty + cl_is_qpool_inited +cl_is_rbmap_empty
-cl_is_rbmap_empty + cl_is_state_valid + cl_is_sys_callback_inited +cl_list.h
-cl_list.h + cl_list_apply_func + cl_list_construct +cl_list_count
-cl_list_count + cl_list_destroy + cl_list_end +cl_list_find_from_head
-cl_list_find_from_head + cl_list_find_from_tail + cl_list_head +cl_list_init
-cl_list_init + cl_list_insert_array_head + cl_list_insert_array_tail +cl_list_insert_head
-cl_list_insert_head + cl_list_insert_next + cl_list_insert_prev +cl_list_insert_tail
-cl_list_insert_tail + cl_list_item_t + cl_list_iterator_t +cl_list_next
-cl_list_next + cl_list_obj + cl_list_obj_t +cl_list_prev
-cl_list_prev + cl_list_remove_all + cl_list_remove_head +cl_list_remove_item
-cl_list_remove_item + cl_list_remove_object + cl_list_remove_tail +cl_list_t
-cl_list_t + cl_list_tail + cl_log.h +cl_log_event
-cl_log_event + cl_log_type_t + cl_malloc +cl_map.h
-cl_map.h + cl_map_construct + cl_map_count +cl_map_delta
-cl_map_delta + cl_map_destroy + cl_map_end +cl_map_get
-cl_map_get + cl_map_head + cl_map_init +cl_map_insert
-cl_map_insert + cl_map_item_t + cl_map_iterator_t +cl_map_key
-cl_map_key + cl_map_merge + cl_map_next +cl_map_obj
-cl_map_obj + cl_map_obj_t + cl_map_prev +cl_map_remove
-cl_map_remove + cl_map_remove_all + cl_map_remove_item +cl_map_t
-cl_map_t + cl_map_tail + cl_math.h +cl_mem_display
-cl_mem_display + cl_memclr + cl_memcmp +cl_memcpy
-cl_memcpy + cl_memory.h + cl_memset +cl_msg_out
-cl_msg_out + cl_mutex.h + cl_mutex_acquire +cl_mutex_construct
-cl_mutex_construct + cl_mutex_destroy + cl_mutex_init +cl_mutex_release
-cl_mutex_release + cl_ntoh + CL_NTOH16 +cl_ntoh16
-cl_ntoh16 + cl_ntoh32 + CL_NTOH32 +CL_NTOH64
+ cl_ntoh64 -CL_NTOH64 + cl_obj.h +cl_obj_construct
-cl_obj_construct + cl_obj_deinit + cl_obj_deref +cl_obj_destroy
-cl_obj_destroy + cl_obj_init + cl_obj_insert_rel +cl_obj_insert_rel_parent_locked
-cl_obj_insert_rel_parent_locked + cl_obj_lock + cl_obj_mgr_create +cl_obj_mgr_destroy
-cl_obj_mgr_destroy + cl_obj_mgr_t + cl_obj_ref +cl_obj_rel_t
-cl_obj_rel_t + cl_obj_remove_rel + cl_obj_reset +cl_obj_t
-cl_obj_t + cl_obj_type + cl_obj_unlock +cl_palloc
-cl_palloc + cl_panic + cl_passivelock.h +cl_perf.h
-cl_perf.h + cl_perf_clr + cl_perf_construct +cl_perf_destroy
-cl_perf_destroy + cl_perf_display + cl_perf_inc +cl_perf_init
-cl_perf_init + cl_perf_log + cl_perf_reset +cl_perf_start
-cl_perf_start + cl_perf_stop + cl_perf_update +cl_perf_update_ctr
-cl_perf_update_ctr + cl_pfn_async_proc_cb_t + cl_pfn_cpool_dtor_t +cl_pfn_cpool_init_t
-cl_pfn_cpool_init_t + cl_pfn_fmap_apply_t + cl_pfn_fmap_cmp_t +cl_pfn_ioctl_handler_t
-cl_pfn_ioctl_handler_t + cl_pfn_list_apply_t + cl_pfn_list_find_t +cl_pfn_obj_call_t
-cl_pfn_obj_call_t + cl_pfn_pnp_po_t + cl_pfn_pool_dtor_t +cl_pfn_pool_init_t
-cl_pfn_pool_init_t + cl_pfn_ptr_vec_apply_t + cl_pfn_ptr_vec_find_t +cl_pfn_qcpool_dtor_t
-cl_pfn_qcpool_dtor_t + cl_pfn_qcpool_init_t + cl_pfn_qlist_apply_t +cl_pfn_qlist_find_t
-cl_pfn_qlist_find_t + cl_pfn_qmap_apply_t + cl_pfn_qpool_dtor_t +cl_pfn_qpool_init_t
-cl_pfn_qpool_init_t + cl_pfn_query_text_t + cl_pfn_release_resources_t +cl_pfn_req_cb_t
-cl_pfn_req_cb_t + cl_pfn_reqmgr_get_count_t + cl_pfn_sys_callback_t +cl_pfn_thread_callback_t
-cl_pfn_thread_callback_t + cl_pfn_timer_callback_t + cl_pfn_vec_apply_t +cl_pfn_vec_dtor_t
-cl_pfn_vec_dtor_t + cl_pfn_vec_find_t + cl_pfn_vec_init_t +cl_plock_acquire
-cl_plock_acquire + cl_plock_construct + cl_plock_destroy +cl_plock_excl_acquire
-cl_plock_excl_acquire + cl_plock_init + cl_plock_release +cl_plock_t
-cl_plock_t + cl_pnp + cl_pnp_po.h +cl_pnp_po_ext_t
-cl_pnp_po_ext_t + cl_pnp_state_t + cl_pool.h +cl_pool_construct
-cl_pool_construct + cl_pool_count + cl_pool_destroy +cl_pool_get
-cl_pool_get + cl_pool_grow + cl_pool_init +cl_pool_item_t
-cl_pool_item_t + cl_pool_put + cl_pool_t +cl_power
-cl_power + CL_PRINT + cl_proc_count +cl_ptr_vector.h
-cl_ptr_vector.h + cl_ptr_vector_apply_func + cl_ptr_vector_at +cl_ptr_vector_construct
-cl_ptr_vector_construct + cl_ptr_vector_destroy + cl_ptr_vector_find_from_end +cl_ptr_vector_find_from_start
-cl_ptr_vector_find_from_start + cl_ptr_vector_get + cl_ptr_vector_get_capacity +cl_ptr_vector_get_size
-cl_ptr_vector_get_size + cl_ptr_vector_init + cl_ptr_vector_insert +cl_ptr_vector_remove
-cl_ptr_vector_remove + cl_ptr_vector_set + cl_ptr_vector_set_capacity +cl_ptr_vector_set_min_size
-cl_ptr_vector_set_min_size + cl_ptr_vector_set_size + cl_ptr_vector_t +cl_pzalloc
-cl_pzalloc + cl_qcomppool.h + cl_qcpool_construct +cl_qcpool_count
-cl_qcpool_count + cl_qcpool_destroy + cl_qcpool_get +cl_qcpool_grow
-cl_qcpool_grow + cl_qcpool_init + cl_qcpool_put +cl_qcpool_put_list
-cl_qcpool_put_list + cl_qcpool_t + cl_qlist.h +cl_qlist_apply_func
-cl_qlist_apply_func + cl_qlist_count + cl_qlist_end +cl_qlist_find_from_head
-cl_qlist_find_from_head + cl_qlist_find_from_tail + cl_qlist_find_next +cl_qlist_find_prev
-cl_qlist_find_prev + cl_qlist_head + cl_qlist_init +cl_qlist_insert_array_head
-cl_qlist_insert_array_head + cl_qlist_insert_array_tail + cl_qlist_insert_head +cl_qlist_insert_list_head
-cl_qlist_insert_list_head + cl_qlist_insert_list_tail + cl_qlist_insert_next +cl_qlist_insert_prev
-cl_qlist_insert_prev + cl_qlist_insert_tail + cl_qlist_move_items +cl_qlist_next
-cl_qlist_next + cl_qlist_obj + cl_qlist_prev +cl_qlist_remove_all
-cl_qlist_remove_all + cl_qlist_remove_head + cl_qlist_remove_item +cl_qlist_remove_tail
-cl_qlist_remove_tail + cl_qlist_set_obj + cl_qlist_t +cl_qlist_tail
-cl_qlist_tail + cl_qlock_pool_construct + cl_qlock_pool_destroy +cl_qlock_pool_get
-cl_qlock_pool_get + cl_qlock_pool_init + cl_qlock_pool_put +cl_qlock_pool_t
-cl_qlock_pool_t + cl_qlockpool.h + cl_qmap.h +cl_qmap_apply_func
-cl_qmap_apply_func + cl_qmap_count + cl_qmap_delta +cl_qmap_end
-cl_qmap_end + cl_qmap_get + cl_qmap_head +cl_qmap_init
-cl_qmap_init + cl_qmap_insert + cl_qmap_key +cl_qmap_merge
-cl_qmap_merge + cl_qmap_next + cl_qmap_obj +cl_qmap_prev
-cl_qmap_prev + cl_qmap_remove + cl_qmap_remove_all +cl_qmap_remove_item
-cl_qmap_remove_item + cl_qmap_set_obj + cl_qmap_t +cl_qmap_tail
-cl_qmap_tail + cl_qpool.h + cl_qpool_construct +cl_qpool_count
-cl_qpool_count + cl_qpool_destroy + cl_qpool_get +cl_qpool_grow
-cl_qpool_grow + cl_qpool_init + cl_qpool_put +cl_qpool_put_list
-cl_qpool_put_list + cl_qpool_t + cl_rbmap.h +cl_rbmap_count
-cl_rbmap_count + cl_rbmap_end + cl_rbmap_init +cl_rbmap_insert
-cl_rbmap_insert + cl_rbmap_item_t + cl_rbmap_left +cl_rbmap_remove_item
-cl_rbmap_remove_item + cl_rbmap_reset + cl_rbmap_right +cl_rbmap_root
-cl_rbmap_root + cl_rbmap_t + cl_rel_alloc +cl_rel_free
-cl_rel_free + cl_req_mgr_construct + cl_req_mgr_destroy +cl_req_mgr_get
-cl_req_mgr_get + cl_req_mgr_init + cl_req_mgr_resume +cl_req_mgr_t
-cl_req_mgr_t + cl_req_type_t + cl_reqmgr.h +cl_rollback_pnp_state
-cl_rollback_pnp_state + cl_set_pnp_state + cl_spinlock.h +cl_spinlock_acquire
-cl_spinlock_acquire + cl_spinlock_construct + cl_spinlock_destroy +cl_spinlock_init
-cl_spinlock_init + cl_spinlock_release + CL_STATUS_MSG +cl_status_t
-cl_status_t + cl_sys_callback_get + cl_sys_callback_put +cl_sys_callback_queue
-cl_sys_callback_queue + cl_syscallback.h + cl_thread.h +cl_thread_pool_construct
-cl_thread_pool_construct + cl_thread_pool_destroy + cl_thread_pool_init +cl_thread_pool_signal
-cl_thread_pool_signal + cl_thread_pool_t + cl_thread_stall +cl_thread_suspend
-cl_thread_suspend + cl_threadpool.h + cl_timer.h +cl_timer_construct
-cl_timer_construct + cl_timer_destroy + cl_timer_init +cl_timer_start
-cl_timer_start + cl_timer_stop + cl_timer_trim +CL_TRACE
-CL_TRACE + CL_TRACE_EXIT + cl_types.h +cl_vector.h
-cl_vector.h + cl_vector_apply_func + cl_vector_at +cl_vector_construct
-cl_vector_construct + cl_vector_destroy + cl_vector_find_from_end +cl_vector_find_from_start
-cl_vector_find_from_start + cl_vector_get + cl_vector_get_capacity +cl_vector_get_ptr
-cl_vector_get_ptr + cl_vector_get_size + cl_vector_init +cl_vector_set
-cl_vector_set + cl_vector_set_capacity + cl_vector_set_min_size +cl_vector_set_size
-cl_vector_set_size + cl_vector_t + cl_vfptr_pnp_po_t +cl_vfptr_query_txt
-cl_vfptr_query_txt + cl_waitobj.h + cl_waitobj_create +cl_waitobj_deref
-cl_waitobj_deref + cl_waitobj_destroy + cl_waitobj_handle_t +cl_waitobj_ref
-cl_waitobj_ref + cl_waitobj_reset + cl_waitobj_signal +cl_waitobj_wait_on
-cl_waitobj_wait_on + cl_zalloc + comp_lib.h +Component Library
+ Composite Pool Constants + Data Types
+ Debug Levels + Debug Output -DM_SVC_NAME +dhcp_pkt_t
+ +DM_SVC_NAME +eth_hdr_t Event +
Flexi Map ib_access_t
ib_add_svc_entry
ib_al.h ib_al_flags_t
-ib_al_ifc.h + ib_al_ifc.h -ib_al_ioctl.h
+ +ib_al_ioctl.h ib_alloc_pd + ib_api_status_t -ib_apm_state_t
+ +ib_apm_state_t ib_apr_info_t + ib_apr_pdata_t -ib_apr_status_t
+ +ib_apr_status_t ib_ari_t + ib_async_event_rec_t -ib_async_event_t
+ +ib_async_event_t ib_atomic_t + ib_av_attr_t -ib_bind_mw
+ +ib_bind_mw ib_bind_wr_t + ib_ca_attr_t -ib_ca_mod_t
+ +ib_ca_mod_t ib_cancel_mad + ib_cancel_query -ib_cep_listen_t
+ +ib_cep_listen_t ib_ci.h + ib_ci_call -ib_ci_ifc.h
+ ib_ci_ifc.h + +ib_ci_ifc_t ib_ci_op_t -IB_CLASS_CAP_GETSET
+ +IB_CLASS_CAP_GETSET IB_CLASS_CAP_TRAP + ib_class_is_vendor_specific -ib_class_is_vendor_specific_high
+ +ib_class_is_vendor_specific_high ib_class_is_vendor_specific_low + ib_class_port_info_t -IB_CLASS_RESP_TIME_MASK
+ +IB_CLASS_RESP_TIME_MASK ib_close_al + ib_close_ca -ib_cm_apr
+ +ib_cm_apr ib_cm_apr_rec_t + ib_cm_apr_t -ib_cm_cancel
+ +ib_cm_cancel ib_cm_cap_mask_t + ib_cm_drep -ib_cm_drep_rec_t
+ +ib_cm_drep_rec_t ib_cm_drep_t + ib_cm_dreq -ib_cm_dreq_rec_t
+ +ib_cm_dreq_rec_t ib_cm_dreq_t + ib_cm_failover_t -ib_cm_handoff
+ +ib_cm_handoff ib_cm_lap + ib_cm_lap_rec_t -ib_cm_lap_t
+ +ib_cm_lap_t ib_cm_listen + ib_cm_listen_t -ib_cm_mra
+ +ib_cm_mra ib_cm_mra_rec_t + ib_cm_mra_t -ib_cm_rej
+ +ib_cm_rej ib_cm_rej_rec_t + ib_cm_rej_t -ib_cm_rep
+ +ib_cm_rep ib_cm_rep_rec_t + ib_cm_rep_t -ib_cm_req
+ +ib_cm_req ib_cm_req_rec_t + ib_cm_req_t -ib_cm_rtu
+ +ib_cm_rtu ib_cm_rtu_rec_t + ib_cm_rtu_t -ib_copy_ca_attr
+ +ib_copy_ca_attr ib_cq_create_t + ib_create_av -ib_create_cq
+ +ib_create_cq ib_create_ioc + ib_create_mad_pool -ib_create_mw
+ +ib_create_mw ib_create_qp + ib_dealloc_pd -IB_DEFAULT_PKEY
+ +IB_DEFAULT_PKEY IB_DEFAULT_SUBNET_PREFIX + ib_dereg_mad_pool -ib_dereg_mr
+ +ib_dereg_mr ib_dereg_pnp + ib_dereg_svc -ib_deregister_ca
+ +ib_deregister_ca ib_destroy_av + ib_destroy_cq -ib_destroy_ioc
+ +ib_destroy_ioc ib_destroy_mad_pool + ib_destroy_mw -ib_destroy_qp
+ +ib_destroy_qp ib_device_attr_mask_t + ib_dgrm_info_t -ib_dm_get_slot_lo_hi
+ +ib_dm_get_slot_lo_hi ib_dm_mad_t + ib_dm_set_slot_lo_hi -ib_drep_pdata_t
+ +ib_drep_pdata_t ib_dreq_pdata_t + ib_event_rec_t -ib_field32_t
+ +ib_field32_t ib_force_apm + ib_get_async_event_str -ib_get_ca_by_gid
+ +ib_get_ca_by_gid ib_get_ca_guids + ib_get_err_str -ib_get_guid
+ +ib_get_guid ib_get_mad + ib_get_mad_buf -ib_get_node_type_str
+ +ib_get_node_type_str ib_get_port_by_gid + ib_get_port_state_from_str -ib_get_port_state_str
+ +ib_get_port_state_str ib_get_query_node_rec + ib_get_query_path_rec -ib_get_query_portinfo_rec
+ +ib_get_query_portinfo_rec ib_get_query_result + ib_get_query_svc_rec -ib_get_spl_qp
+ +ib_get_spl_qp ib_get_wc_status_str + ib_get_wc_type_str -ib_get_wr_type_str
+ +ib_get_wr_type_str ib_gid_get_guid + ib_gid_get_subnet_prefix -ib_gid_is_link_local
+ +ib_gid_is_link_local ib_gid_is_site_local + ib_gid_pair_t -ib_gid_prefix_t
+ +ib_gid_prefix_t ib_gid_set_default + ib_gid_t -ib_gmp_t
+ +ib_gmp_t ib_grh_get_ver_class_flow + ib_grh_set_ver_class_flow -ib_grh_t
+ +ib_grh_t ib_guid_info_t + ib_guid_pair_t -ib_inform_get_dev_id
+ +ib_inform_get_dev_id ib_inform_get_prod_type + ib_inform_get_qpn -ib_inform_get_resp_time_val
+ +ib_inform_get_resp_time_val ib_inform_get_trap_num + ib_inform_get_vend_id -ib_inform_info_record_t
+ +ib_inform_info_record_t ib_inform_set_dev_id + ib_inform_set_prod_type -ib_inform_set_qpn
+ +ib_inform_set_qpn ib_inform_set_resp_time_val + ib_inform_set_trap_num -ib_inform_set_vend_id
+ +ib_inform_set_vend_id ib_init_dgrm_svc + ib_init_type_t -IB_INVALID_PORT_NUM
+ +IB_INVALID_PORT_NUM ib_ioc_profile_t + ib_iou_info_diag_dev_id -ib_iou_info_option_rom
+ +ib_iou_info_option_rom ib_iou_info_t + ib_join_mcast -ib_lap_pdata_t
+ +ib_lap_pdata_t ib_leave_mcast + ib_lft_record_t -IB_LID_MCAST_END
+ +IB_LID_MCAST_END IB_LID_MCAST_START + ib_lid_pair_t -IB_LID_PERMISSIVE
+ +IB_LID_PERMISSIVE IB_LID_UCAST_END + IB_LID_UCAST_START -ib_link_states_t
+ +ib_link_states_t ib_listen_err_rec_t + ib_listen_info_t -ib_local_ds_t
+ +ib_local_ds_t ib_local_mad + IB_MAD_ATTR_CLASS_PORT_INFO -IB_MAD_ATTR_DIAG_CODE
+ +IB_MAD_ATTR_DIAG_CODE IB_MAD_ATTR_DIAGNOSTIC_TIMEOUT + IB_MAD_ATTR_GUID_INFO -IB_MAD_ATTR_INFORM_INFO
+ +IB_MAD_ATTR_INFORM_INFO IB_MAD_ATTR_IO_UNIT_INFO + IB_MAD_ATTR_IOC_PROFILE -IB_MAD_ATTR_LED_INFO
+ +IB_MAD_ATTR_LED_INFO IB_MAD_ATTR_LFT_RECORD + IB_MAD_ATTR_LIN_FWD_TBL -IB_MAD_ATTR_LINK_RECORD
+ +IB_MAD_ATTR_LINK_RECORD IB_MAD_ATTR_MCAST_FWD_TBL + IB_MAD_ATTR_MCMEMBER_RECORD -IB_MAD_ATTR_MULTIPATH_RECORD
-IB_MAD_ATTR_NODE_DESC + +IB_MAD_ATTR_MULTIPATH_RECORD +IB_MAD_ATTR_NODE_DESC IB_MAD_ATTR_NODE_INFO -IB_MAD_ATTR_NODE_RECORD
+ +IB_MAD_ATTR_NODE_RECORD IB_MAD_ATTR_NOTICE + IB_MAD_ATTR_P_KEY_TABLE -IB_MAD_ATTR_PATH_RECORD
+ +IB_MAD_ATTR_PATH_RECORD IB_MAD_ATTR_PKEYTBL_RECORD + IB_MAD_ATTR_PORT_CNTRS -IB_MAD_ATTR_PORT_INFO
+ +IB_MAD_ATTR_PORT_INFO IB_MAD_ATTR_PORT_SMPL_CTRL + IB_MAD_ATTR_PORT_SMPL_RSLT -IB_MAD_ATTR_PORTINFO_RECORD
+ +IB_MAD_ATTR_PORTINFO_RECORD IB_MAD_ATTR_PREPARE_TO_TEST + IB_MAD_ATTR_RND_FWD_TBL -IB_MAD_ATTR_SERVICE_ENTRIES
+ +IB_MAD_ATTR_SERVICE_ENTRIES IB_MAD_ATTR_SERVICE_RECORD + IB_MAD_ATTR_SLVL_RECORD -IB_MAD_ATTR_SLVL_TABLE
+ +IB_MAD_ATTR_SLVL_TABLE IB_MAD_ATTR_SM_INFO + IB_MAD_ATTR_SMINFO_RECORD -IB_MAD_ATTR_SVC_ASSOCIATION_RECORD
+ +IB_MAD_ATTR_SVC_ASSOCIATION_RECORD IB_MAD_ATTR_SWITCH_INFO + IB_MAD_ATTR_TEST_DEVICE_LOOP -IB_MAD_ATTR_TEST_DEVICE_ONCE
+ +IB_MAD_ATTR_TEST_DEVICE_ONCE IB_MAD_ATTR_TRACE_RECORD + IB_MAD_ATTR_VENDOR_DIAG -IB_MAD_ATTR_VL_ARBITRATION
+ +IB_MAD_ATTR_VL_ARBITRATION IB_MAD_ATTR_VLARB_RECORD + ib_mad_element_t -ib_mad_init_new
+ +ib_mad_init_new ib_mad_init_response + ib_mad_is_response -IB_MAD_METHOD_GET
+ +IB_MAD_METHOD_GET IB_MAD_METHOD_GET_RESP + IB_MAD_METHOD_GETTABLE -IB_MAD_METHOD_GETTABLE_RESP
+ +IB_MAD_METHOD_GETTABLE_RESP IB_MAD_METHOD_REPORT + IB_MAD_METHOD_REPORT_RESP -IB_MAD_METHOD_RESP_MASK
+ +IB_MAD_METHOD_RESP_MASK IB_MAD_METHOD_SEND + IB_MAD_METHOD_SET -IB_MAD_METHOD_TRAP
+ +IB_MAD_METHOD_TRAP IB_MAD_METHOD_TRAP_REPRESS + IB_MAD_STATUS_BUSY -IB_MAD_STATUS_INVALID_FIELD
+ +IB_MAD_STATUS_INVALID_FIELD IB_MAD_STATUS_REDIRECT + IB_MAD_STATUS_UNSUP_CLASS_VER -IB_MAD_STATUS_UNSUP_METHOD
+ +IB_MAD_STATUS_UNSUP_METHOD IB_MAD_STATUS_UNSUP_METHOD_ATTR + ib_mad_svc_t -ib_mad_svc_type_t
+ +ib_mad_svc_type_t ib_mad_t + IB_MAX_METHOD -IB_MCAST_BLOCK_ID_MASK_HO
+ +IB_MCAST_BLOCK_ID_MASK_HO IB_MCAST_BLOCK_SIZE + IB_MCAST_MASK_SIZE -IB_MCAST_MAX_BLOCK_ID
+ +IB_MCAST_MAX_BLOCK_ID IB_MCAST_POSITION_MASK_HO + IB_MCAST_POSITION_MAX -IB_MCAST_POSITION_SHIFT
+ +IB_MCAST_POSITION_SHIFT ib_mcast_rec_t + ib_mcast_req_t -IB_MCLASS_BM
+ +IB_MCLASS_BM IB_MCLASS_COMM_MGMT + IB_MCLASS_DEV_MGMT -IB_MCLASS_PERF
+ +IB_MCLASS_PERF IB_MCLASS_SNMP + IB_MCLASS_SUBN_ADM -IB_MCLASS_SUBN_DIR
+ +IB_MCLASS_SUBN_DIR IB_MCLASS_SUBN_LID + IB_MCLASS_VENDOR_HIGH_RANGE_MAX -IB_MCLASS_VENDOR_HIGH_RANGE_MIN
+ +IB_MCLASS_VENDOR_HIGH_RANGE_MIN IB_MCLASS_VENDOR_LOW_RANGE_MAX + IB_MCLASS_VENDOR_LOW_RANGE_MIN -ib_member_get_scope
+ +ib_member_get_scope ib_member_get_scope_state + ib_member_get_sl_flow_hop -ib_member_get_state
+ +ib_member_get_state ib_member_rec_t + ib_member_set_join_state -ib_member_set_scope
+ +ib_member_set_scope ib_member_set_scope_state + ib_member_set_sl_flow_hop -ib_member_set_state
+ +ib_member_set_state ib_modify_av + ib_modify_ca -ib_modify_cq
+ +ib_modify_cq ib_modify_qp + ib_mr_attr_t -ib_mr_create_t
+ +ib_mr_create_t ib_mr_mod_t + ib_mra_pdata_t -IB_MTU_TYPE
+ +IB_MTU_TYPE ib_net16_t + ib_net32_t -ib_net64_t
+ +ib_net64_t ib_node_info_get_local_port_num + ib_node_info_get_vendor_id -ib_node_info_t
+ +ib_node_info_t IB_NODE_NUM_PORTS_MAX + IB_NODE_TYPE_CA -IB_NODE_TYPE_ROUTER
+ +IB_NODE_TYPE_ROUTER IB_NODE_TYPE_SWITCH + ib_notice_get_count -ib_notice_get_dev_id
+ +ib_notice_get_dev_id ib_notice_get_generic + ib_notice_get_prod_type -ib_notice_get_toggle
+ +ib_notice_get_toggle ib_notice_get_trap_num + ib_notice_get_type -ib_notice_get_vend_id
+ +ib_notice_get_vend_id IB_NOTICE_NODE_TYPE_CA + IB_NOTICE_NODE_TYPE_ROUTER -IB_NOTICE_NODE_TYPE_SUBN_MGMT
+ +IB_NOTICE_NODE_TYPE_SUBN_MGMT IB_NOTICE_NODE_TYPE_SWITCH + ib_notice_set_count -ib_notice_set_dev_id
+ +ib_notice_set_dev_id ib_notice_set_generic + ib_notice_set_prod_type -ib_notice_set_toggle
+ +ib_notice_set_toggle ib_notice_set_trap_num + ib_notice_set_type -ib_notice_set_vend_id
+ +ib_notice_set_vend_id ib_open_al + ib_open_ca -ib_path_get_ipd
+ +ib_path_get_ipd IB_PATH_REC_BASE_MASK + ib_path_rec_flow_lbl -ib_path_rec_hop_limit
+ +ib_path_rec_hop_limit ib_path_rec_init_local + ib_path_rec_mtu -ib_path_rec_mtu_sel
+ +ib_path_rec_mtu_sel ib_path_rec_pkt_life + ib_path_rec_pkt_life_sel -ib_path_rec_rate
+ +ib_path_rec_rate ib_path_rec_rate_sel + IB_PATH_REC_SELECTOR_MASK -ib_path_rec_set_hop_flow_raw
+ +ib_path_rec_set_hop_flow_raw ib_path_rec_sl + ib_path_rec_t -IB_PATH_SELECTOR_TYPE
+ +IB_PATH_SELECTOR_TYPE ib_pd_type_t + ib_peek_cq -ib_pfn_cm_apr_cb_t
+ +ib_pfn_cm_apr_cb_t ib_pfn_cm_drep_cb_t + ib_pfn_cm_dreq_cb_t -ib_pfn_cm_lap_cb_t
+ +ib_pfn_cm_lap_cb_t ib_pfn_cm_mra_cb_t + ib_pfn_cm_rej_cb_t -ib_pfn_cm_rep_cb_t
+ +ib_pfn_cm_rep_cb_t ib_pfn_cm_req_cb_t + ib_pfn_cm_rtu_cb_t -ib_pfn_comp_cb_t
+ +ib_pfn_comp_cb_t ib_pfn_destroy_cb_t + ib_pfn_event_cb_t -ib_pfn_listen_err_cb_t
+ +ib_pfn_listen_err_cb_t ib_pfn_mad_comp_cb_t + ib_pfn_mcast_cb_t -ib_pfn_pnp_cb_t
+ +ib_pfn_pnp_cb_t ib_pfn_query_cb_t + ib_pfn_reg_svc_cb_t -ib_pfn_report_cb_t
+ +ib_pfn_report_cb_t ib_pfn_sub_cb_t + ib_phys_create_t -ib_phys_range_t
+ +ib_phys_range_t IB_PKEY_BASE_MASK + IB_PKEY_ENTRIES_MAX -ib_pkey_get_base
+ +ib_pkey_get_base ib_pkey_is_full_member + IB_PKEY_MAX_BLOCKS -ib_pkey_table_info_t
+ +ib_pkey_table_info_t IB_PKEY_TYPE_MASK + ib_pnp_ca_rec_t -ib_pnp_class_t
+ +ib_pnp_class_t ib_pnp_event_t + ib_pnp_ioc_path_rec_t -ib_pnp_ioc_rec_t
+ +ib_pnp_ioc_rec_t ib_pnp_iou_rec_t + ib_pnp_port_rec_t -ib_pnp_rec_t
+ +ib_pnp_rec_t ib_pnp_req_t + ib_poll_cq -ib_port_attr_mod_t
+ +ib_port_attr_mod_t ib_port_attr_t + ib_port_cap_t -ib_port_counters_t
+ +ib_port_counters_t ib_port_info_compute_rate + ib_port_info_get_link_speed_active -ib_port_info_get_link_speed_sup
+ +ib_port_info_get_link_speed_sup ib_port_info_get_lmc + ib_port_info_get_mpb -ib_port_info_get_mtu_cap
+ +ib_port_info_get_mtu_cap ib_port_info_get_neighbor_mtu + ib_port_info_get_op_vls -ib_port_info_get_port_state
+ +ib_port_info_get_port_state +ib_port_info_get_sm_sl ib_port_info_get_vl_cap -ib_port_info_set_link_speed_sup -ib_port_info_set_lmc
+ +ib_port_info_set_link_speed_sup +ib_port_info_set_lmc ib_port_info_set_mpb -ib_port_info_set_neighbor_mtu -ib_port_info_set_op_vls
+ +ib_port_info_set_neighbor_mtu +ib_port_info_set_op_vls ib_port_info_set_port_state +
+ib_port_info_set_sm_sl ib_port_info_set_state_no_change + ib_port_info_set_timeout
+
ib_port_info_t + ib_post_recv + ib_post_send
+
ib_put_mad + IB_QP1_WELL_KNOWN_Q_KEY + ib_qp_attr_t
+
ib_qp_create_t + ib_qp_mod_t + ib_qp_opts_t
+
ib_qp_state_t + ib_qp_type_t + ib_query
+
ib_query_av + ib_query_ca + ib_query_ca_by_guid
+
ib_query_cq + ib_query_mr + ib_query_mw
+
ib_query_qp + ib_query_rec_t + ib_query_req_t
+
ib_query_type_t + ib_rearm_cq + ib_rearm_n_cq
+
ib_recv_opt_t + ib_recv_wr_t + ib_reg_ioc
+
ib_reg_mad_pool + ib_reg_mad_svc + ib_reg_mem
+
ib_reg_phys + ib_reg_pnp + ib_reg_shared
+
ib_reg_shmid + ib_reg_svc + ib_reg_svc_rec_t
+
ib_reg_svc_req_t + ib_register_ca + ib_rej_pdata_t
+
ib_rej_status_t + ib_reject_ioc + ib_remove_svc_entry
+
ib_rep_pdata_t + ib_report_rec_t + ib_req_pdata_t
+
ib_rereg_mem + ib_rereg_phys + ib_rmpp_is_flag_set
+
ib_rmpp_mad_t + ib_rtu_pdata_t + ib_sa_mad_get_payload_ptr
+
ib_sa_mad_t + ib_send_mad + ib_send_opt_t
+
ib_send_wr_t + ib_shmid_t + ib_sidr_rep_pdata_t
+
ib_sidr_req_pdata_t + ib_slvl_table_get_vl + ib_slvl_table_record_t
+
ib_slvl_table_set_vl + ib_slvl_table_t + ib_sm_info_t
+
IB_SMINFO_ATTR_MOD_ACKNOWLEDGE + IB_SMINFO_ATTR_MOD_DISABLE + IB_SMINFO_ATTR_MOD_DISCOVER
+
IB_SMINFO_ATTR_MOD_HANDOVER + IB_SMINFO_ATTR_MOD_STANDBY + ib_sminfo_get_priority
+
ib_sminfo_get_state + IB_SMINFO_STATE_DISCOVERING + IB_SMINFO_STATE_INIT
+
IB_SMINFO_STATE_MASTER + IB_SMINFO_STATE_NOTACTIVE + IB_SMINFO_STATE_STANDBY
+
IB_SMP_DIRECTION + ib_smp_get_payload_ptr + ib_smp_get_status
+
ib_smp_init_new + ib_smp_is_d + ib_smp_is_response
+
IB_SMP_STATUS_MASK + ib_smp_t + ib_sub_rec_t
+
ib_sub_req_t + IB_SUBNET_PATH_HOPS_MAX + ib_subscribe
+
ib_svc_entries_t + ib_svc_entry_t + ib_switch_info_clear_state_change
+
ib_switch_info_get_state_change + ib_switch_info_t + ib_sync_destroy
+
ib_types.h + ib_unsubscribe + ib_user_query_t
+
ib_uvp.h + ib_vl_arb_element_get_vl + ib_vl_arb_element_set_vl
+
ib_vl_arb_element_t + ib_vl_arb_table_record_t + ib_vl_arb_table_t
+
ib_wc_status_t + ib_wc_t + ib_wc_type_t
+
ib_wr_type_t + +IO Controler Interface ioc_at_slot -ioc_ifc.h
+
ioc_ifc.h + +ioc_ifc_data_t IOCTL Object -IOCTL_CODE
+IOCTL_CODE iou_ifc.h -iou_ifc.h +iou_ifc_data_t
+ip_hdr_t +ip_packet.h -ipoib_ifc.h
ipoib_ifc.h + +ipoib_ifc_data_t Irqlock -Join States
+ +Join States List + Log Provider -MAD_BLOCK_GRH_SIZE
+ +mac_addr_t +MAD_BLOCK_GRH_SIZE MAD_BLOCK_SIZE -MAD_RMPP_DATA_SIZE -MAD_RMPP_HDR_SIZE
+ +MAD_RMPP_DATA_SIZE +MAD_RMPP_HDR_SIZE Map +
MAX Memory Management
+ MIN
mlnx_create_fmr mlnx_destroy_fmr
mlnx_fmr_create_t
mlnx_map_fmr mlnx_unmap_fmr
Mutex -Object -Object States
+ +Object +Object States offsetof -Overview -Overview
-Overview user-mode Verbs + Parameter Keywords + PARENT_STRUCT +Passive Lock
-Passive Lock + PERF_DECLARE + PERF_DECLARE_START +Performance Counters
-Performance Counters + Plug and Play + Pointer Vector +Pool
-Pool + Quick Composite Pool + Quick List +Quick Locking Pool
-Quick Locking Pool + Quick Map + Quick Pool +RB Map
-RB Map + Request Manager + ROUNDUP +Spinlock
-Spinlock + System Callback +tcp_hdr_t Thread Pool
Type Definitions + ual_alloc_pd_ioctl_t
+ ual_attach_mcast_ioctl_t + ual_bind_file_ioctl_t + ual_bind_mw_ioctl_t
+ ual_cancel_mad_ioctl_t + ual_cancel_sa_req_ioctl_t + ual_cep_apr_ioctl_t
+ ual_cep_drep_ioctl_t + ual_cep_dreq_ioctl_t + ual_cep_get_rtr_ioctl_t
+ ual_cep_get_rts_ioctl_t + ual_cep_get_timewait_ioctl_t + ual_cep_handoff_ioctl_t
+ ual_cep_lap_ioctl_t + ual_cep_listen_ioctl_t + ual_cep_mra_ioctl_t
+ ual_cep_poll_ioctl_t + ual_cep_rej_ioctl_t + ual_cep_rep_ioctl_t
+ ual_cep_rtu_ioctl_t + ual_ci_call_ioctl_t + ual_close_ca_ioctl_t
+ ual_cm_req_ioctl_t + ual_create_av_ioctl_t + ual_create_cep_ioctl_t
+ ual_create_cq_ioctl_t + ual_create_mw_ioctl_t + ual_create_qp_ioctl_t
+ ual_dealloc_pd_ioctl_t + ual_dereg_mad_pool_ioctl_t + ual_dereg_mad_svc_ioctl_t
+ ual_dereg_mr_ioctl_t + ual_dereg_pnp_ioctl_t + ual_destroy_av_ioctl_t
+ ual_destroy_cq_ioctl_t + ual_destroy_mw_ioctl_t + ual_destroy_qp_ioctl_t
+ ual_detach_mcast_ioctl_t + ual_force_apm_ioctl_t + ual_get_uvp_name_t
+ ual_local_mad_ioctl_t + ual_mad_recv_ioctl_t + ual_modify_av_ioctl_t
+ ual_modify_ca_ioctl_t + ual_modify_cq_ioctl_t + ual_modify_qp_ioctl_t
+ ual_open_ca_ioctl_t + ual_peek_cq_ioctl_t + ual_poll_cq_ioctl_t
+ ual_poll_pnp_ioctl_t + ual_post_recv_ioctl_t + ual_post_send_ioctl_t
+ ual_query_av_ioctl_t + ual_query_ca_ioctl_t + ual_query_cq_ioctl_t
+ ual_query_mr_ioctl_t + ual_query_mw_ioctl_t + ual_query_qp_ioctl_t
+ ual_rearm_cq_ioctl_t + ual_rearm_n_cq_ioctl_t + ual_rearm_pnp_ioctl_in_t
+ ual_rearm_pnp_ioctl_out_t + ual_reg_mad_pool_ioctl_t + ual_reg_mad_svc_ioctl_t
+ ual_reg_mem_ioctl_t + ual_reg_pnp_ioctl_in_t + ual_reg_shared_ioctl_t
+ ual_reg_shmid_ioctl_t + ual_rereg_mem_ioctl_t + ual_send_mad_ioctl_t
+ ual_send_sa_req_t + ual_spl_qp_ioctl_t -unsupported functions +udp_hdr_t
+ +unsupported functions UNUSED_PARAM -uvp_bind_mw -uvp_get_interface +user-mode Verbs
+ +uvp_bind_mw +uvp_get_interface uvp_interface_t -uvp_peek_cq -uvp_poll_cq
+ +uvp_peek_cq +uvp_poll_cq uvp_post_allocate_pd_t -uvp_post_attach_mcast_t -uvp_post_ci_call
+ +uvp_post_attach_mcast_t +uvp_post_ci_call uvp_post_close_ca_t -uvp_post_create_av_t -uvp_post_create_cq_t
+ +uvp_post_create_av_t +uvp_post_create_cq_t uvp_post_create_mw_t -uvp_post_create_qp_t -uvp_post_deallocate_pd_t
+ +uvp_post_create_qp_t +uvp_post_deallocate_pd_t uvp_post_destroy_av_t -uvp_post_destroy_cq_t -uvp_post_destroy_mw_t
+ +uvp_post_destroy_cq_t +uvp_post_destroy_mw_t uvp_post_destroy_qp_t -uvp_post_detach_mcast_t -uvp_post_modify_av_t
+ +uvp_post_detach_mcast_t +uvp_post_modify_av_t uvp_post_modify_ca_t -uvp_post_modify_qp_t -uvp_post_open_ca_t
+ +uvp_post_modify_qp_t +uvp_post_open_ca_t uvp_post_query_av_t -uvp_post_query_ca_t -uvp_post_query_cq_t
+ +uvp_post_query_ca_t +uvp_post_query_cq_t uvp_post_query_mw_t -uvp_post_query_qp_t -uvp_post_recv
+ +uvp_post_query_qp_t +uvp_post_recv uvp_post_resize_cq_t -uvp_post_send -uvp_pre_allocate_pd
+ +uvp_post_send +uvp_pre_allocate_pd uvp_pre_attach_mcast -uvp_pre_ci_call -uvp_pre_close_ca_t
+ +uvp_pre_ci_call +uvp_pre_close_ca_t uvp_pre_create_av -uvp_pre_create_cq -uvp_pre_create_mw
+ +uvp_pre_create_cq +uvp_pre_create_mw uvp_pre_create_qp -uvp_pre_deallocate_pd -uvp_pre_destroy_av
+ +uvp_pre_deallocate_pd +uvp_pre_destroy_av uvp_pre_destroy_cq -uvp_pre_destroy_mw -uvp_pre_destroy_qp
+ +uvp_pre_destroy_mw +uvp_pre_destroy_qp uvp_pre_detach_mcast -uvp_pre_modify_av -uvp_pre_modify_ca
+ +uvp_pre_modify_av +uvp_pre_modify_ca uvp_pre_modify_qp -uvp_pre_open_ca_t -uvp_pre_query_av
+ +uvp_pre_open_ca_t +uvp_pre_query_av uvp_pre_query_ca -uvp_pre_query_cq -uvp_pre_query_mw
+ +uvp_pre_query_cq +uvp_pre_query_mw uvp_pre_query_qp -uvp_pre_resize_cq -uvp_rearm_cq
+ +uvp_pre_resize_cq +uvp_rearm_cq uvp_rearm_n_cq
Vector Verbs
Wait Object
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -220,7 +220,7 @@ ib_apm_state_t ib_apr_status_t - @@ -232,311 +232,311 @@ ib_ca_mod_t ib_cm_cap_mask_t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -544,7 +544,7 @@ IB_PKEY_TYPE_MASK ib_pnp_class_t - @@ -566,39 +566,39 @@ ib_rej_status_t - - - - - - - - - - - - - @@ -608,47 +608,47 @@ ib_wc_status_t ib_wc_type_t - - - - - - - - - - - - - - - - diff --git a/trunk/docs/robo_functions.html b/trunk/docs/robo_functions.html index 5ade0c93..bc2e2968 100644 --- a/trunk/docs/robo_functions.html +++ b/trunk/docs/robo_functions.html @@ -7,7 +7,7 @@ -Generated from ./inc/ with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/ with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

[Sourcefiles] @@ -20,1035 +20,1035 @@

Functions

+ 64-bit Print Format ATS + cl_destroy_type_t
+ CL_ENTER + CL_EXIT + CL_HTON16
+ CL_HTON32 + CL_HTON64 + cl_ioctl_handle_t
+ cl_irp_action_t + cl_is_state_valid + cl_list_iterator_t
+ cl_log_type_t + cl_map_iterator_t + CL_NTOH16
+ CL_NTOH32 + CL_NTOH64 + cl_perf_clr
+ cl_perf_inc + cl_perf_log + cl_perf_start
+ cl_perf_stop + cl_perf_update + cl_perf_update_ctr
+ cl_pfn_async_proc_cb_t + cl_pfn_cpool_dtor_t + cl_pfn_cpool_init_t
+ cl_pfn_fmap_apply_t + cl_pfn_fmap_cmp_t + cl_pfn_ioctl_handler_t
+ cl_pfn_list_apply_t + cl_pfn_list_find_t + cl_pfn_obj_call_t
+ cl_pfn_pnp_po_t + cl_pfn_pool_dtor_t + cl_pfn_pool_init_t
+ cl_pfn_ptr_vec_apply_t + cl_pfn_ptr_vec_find_t + cl_pfn_qcpool_dtor_t
+ cl_pfn_qcpool_init_t + cl_pfn_qlist_apply_t + cl_pfn_qlist_find_t
+ cl_pfn_qmap_apply_t + cl_pfn_qpool_dtor_t + cl_pfn_qpool_init_t
+ cl_pfn_query_text_t + cl_pfn_release_resources_t + cl_pfn_req_cb_t
+ cl_pfn_reqmgr_get_count_t + cl_pfn_sys_callback_t + cl_pfn_thread_callback_t
+ cl_pfn_timer_callback_t + cl_pfn_vec_apply_t + cl_pfn_vec_dtor_t
+ cl_pfn_vec_find_t + cl_pfn_vec_init_t + cl_pnp_po_ext_t
+ cl_pnp_state_t + CL_PRINT + cl_req_type_t
+ CL_STATUS_MSG + cl_status_t + CL_TRACE
+ CL_TRACE_EXIT + cl_vfptr_pnp_po_t + cl_vfptr_query_txt
+ cl_waitobj_handle_t + Data Types + Debug Levels
+ DM_SVC_NAME ib_access_t
+ ib_async_event_t ib_atomic_t ib_cm_failover_t + IB_DEFAULT_PKEY
+ IB_DEFAULT_SUBNET_PREFIX ib_device_attr_mask_t + ib_gid_prefix_t
+ ib_gid_t ib_init_type_t + IB_INVALID_PORT_NUM
+ IB_LID_MCAST_END + IB_LID_MCAST_START + IB_LID_PERMISSIVE
+ IB_LID_UCAST_END + IB_LID_UCAST_START + ib_link_states_t
ib_listen_info_t + IB_MAD_ATTR_CLASS_PORT_INFO + IB_MAD_ATTR_DIAG_CODE
+ IB_MAD_ATTR_DIAGNOSTIC_TIMEOUT + IB_MAD_ATTR_GUID_INFO + IB_MAD_ATTR_INFORM_INFO
+ IB_MAD_ATTR_IO_UNIT_INFO + IB_MAD_ATTR_IOC_PROFILE + IB_MAD_ATTR_LED_INFO
+ IB_MAD_ATTR_LFT_RECORD + IB_MAD_ATTR_LIN_FWD_TBL + IB_MAD_ATTR_LINK_RECORD
+ IB_MAD_ATTR_MCAST_FWD_TBL + IB_MAD_ATTR_MCMEMBER_RECORD + IB_MAD_ATTR_MULTIPATH_RECORD
+ IB_MAD_ATTR_NODE_DESC + IB_MAD_ATTR_NODE_INFO + IB_MAD_ATTR_NODE_RECORD
+ IB_MAD_ATTR_NOTICE + IB_MAD_ATTR_P_KEY_TABLE + IB_MAD_ATTR_PATH_RECORD
+ IB_MAD_ATTR_PKEYTBL_RECORD + IB_MAD_ATTR_PORT_CNTRS + IB_MAD_ATTR_PORT_INFO
+ IB_MAD_ATTR_PORT_SMPL_CTRL + IB_MAD_ATTR_PORT_SMPL_RSLT + IB_MAD_ATTR_PORTINFO_RECORD
+ IB_MAD_ATTR_PREPARE_TO_TEST + IB_MAD_ATTR_RND_FWD_TBL + IB_MAD_ATTR_SERVICE_ENTRIES
+ IB_MAD_ATTR_SERVICE_RECORD + IB_MAD_ATTR_SLVL_RECORD + IB_MAD_ATTR_SLVL_TABLE
+ IB_MAD_ATTR_SM_INFO + IB_MAD_ATTR_SMINFO_RECORD + IB_MAD_ATTR_SVC_ASSOCIATION_RECORD
+ IB_MAD_ATTR_SWITCH_INFO + IB_MAD_ATTR_TEST_DEVICE_LOOP + IB_MAD_ATTR_TEST_DEVICE_ONCE
+ IB_MAD_ATTR_TRACE_RECORD + IB_MAD_ATTR_VENDOR_DIAG + IB_MAD_ATTR_VL_ARBITRATION
+ IB_MAD_ATTR_VLARB_RECORD + IB_MAD_METHOD_GET + IB_MAD_METHOD_GET_RESP
+ IB_MAD_METHOD_GETTABLE + IB_MAD_METHOD_GETTABLE_RESP + IB_MAD_METHOD_REPORT
+ IB_MAD_METHOD_REPORT_RESP + IB_MAD_METHOD_RESP_MASK + IB_MAD_METHOD_SEND
+ IB_MAD_METHOD_SET + IB_MAD_METHOD_TRAP + IB_MAD_METHOD_TRAP_REPRESS
+ IB_MAD_STATUS_BUSY + IB_MAD_STATUS_INVALID_FIELD + IB_MAD_STATUS_REDIRECT
+ IB_MAD_STATUS_UNSUP_CLASS_VER + IB_MAD_STATUS_UNSUP_METHOD + IB_MAD_STATUS_UNSUP_METHOD_ATTR
ib_mad_svc_type_t + IB_MAX_METHOD + IB_MCAST_BLOCK_ID_MASK_HO
+ IB_MCAST_BLOCK_SIZE + IB_MCAST_MASK_SIZE + IB_MCAST_MAX_BLOCK_ID
+ IB_MCAST_POSITION_MASK_HO + IB_MCAST_POSITION_MAX + IB_MCAST_POSITION_SHIFT
+ IB_MCLASS_BM + IB_MCLASS_COMM_MGMT + IB_MCLASS_DEV_MGMT
+ IB_MCLASS_PERF + IB_MCLASS_SNMP + IB_MCLASS_SUBN_ADM
+ IB_MCLASS_SUBN_DIR + IB_MCLASS_SUBN_LID + IB_MCLASS_VENDOR_HIGH_RANGE_MAX
+ IB_MCLASS_VENDOR_HIGH_RANGE_MIN + IB_MCLASS_VENDOR_LOW_RANGE_MAX + IB_MCLASS_VENDOR_LOW_RANGE_MIN
ib_mr_mod_t + IB_MTU_TYPE + ib_net16_t
+ ib_net32_t + ib_net64_t + IB_NODE_NUM_PORTS_MAX
+ IB_NODE_TYPE_CA + IB_NODE_TYPE_ROUTER + IB_NODE_TYPE_SWITCH
+ IB_NOTICE_NODE_TYPE_CA + IB_NOTICE_NODE_TYPE_ROUTER + IB_NOTICE_NODE_TYPE_SUBN_MGMT
+ IB_NOTICE_NODE_TYPE_SWITCH + IB_PATH_REC_BASE_MASK + IB_PATH_REC_SELECTOR_MASK
+ IB_PATH_SELECTOR_TYPE ib_pd_type_t + IB_PKEY_BASE_MASK
+ IB_PKEY_ENTRIES_MAX + IB_PKEY_MAX_BLOCKS + IB_PKEY_TYPE_MASK
ib_pnp_event_t + IB_QP1_WELL_KNOWN_Q_KEY
ib_send_opt_t + IB_SMINFO_ATTR_MOD_ACKNOWLEDGE + IB_SMINFO_ATTR_MOD_DISABLE
+ IB_SMINFO_ATTR_MOD_DISCOVER + IB_SMINFO_ATTR_MOD_HANDOVER + IB_SMINFO_ATTR_MOD_STANDBY
+ IB_SMINFO_STATE_DISCOVERING + IB_SMINFO_STATE_INIT + IB_SMINFO_STATE_MASTER
+ IB_SMINFO_STATE_NOTACTIVE + IB_SMINFO_STATE_STANDBY + IB_SMP_DIRECTION
+ IB_SMP_STATUS_MASK + IB_SUBNET_PATH_HOPS_MAX ib_wc_status_t ib_wr_type_t + IOCTL_CODE
+ Join States + MAD_BLOCK_GRH_SIZE + MAD_BLOCK_SIZE
+ MAD_RMPP_DATA_SIZE + MAD_RMPP_HDR_SIZE + MAX
+ MIN + Object States + offsetof
+ Parameter Keywords + PARENT_STRUCT + PERF_DECLARE
+ PERF_DECLARE_START + ROUNDUP + UNUSED_PARAM
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -1068,11 +1068,11 @@ ib_cancel_query ib_ci_call - - - @@ -1144,7 +1144,7 @@ ib_dereg_mr ib_dereg_pnp - @@ -1164,15 +1164,15 @@ ib_destroy_mw ib_destroy_qp - - - @@ -1180,7 +1180,7 @@ ib_get_ca_by_gid ib_get_ca_guids - @@ -1190,15 +1190,15 @@ ib_get_mad - - - @@ -1216,71 +1216,71 @@ ib_get_query_result ib_get_query_svc_rec - - - - - - - - - - - - - - - - - - - - - - - - @@ -1292,35 +1292,35 @@ ib_leave_mcast ib_local_mad - - - - - - - - - - - - @@ -1334,53 +1334,53 @@ ib_modify_cq - - - - - - - - - - - - - - - - - - @@ -1388,35 +1388,35 @@ ib_open_al ib_open_ca - - - - - - - - - - - - @@ -1476,352 +1476,354 @@ ib_pfn_report_cb_t ib_pfn_sub_cb_t - - - - - - - - - - - - + - - - + - - - + - - + + + + + - - + + - - + + - - + + - - + + - - + + - - + + - - - + + - - + + - - - - + + - - - - - - + + - - - + + - - + + - - + + + + - - - - - + + - - + + - - - - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - - + +
+ ci_alloc_mlnx_fmr + ci_allocate_pd + ci_async_event_cb_t
+ ci_attach_mcast + ci_bind_mw + ci_close_ca
+ ci_completion_cb_t + ci_create_av + ci_create_cq
+ ci_create_mw + ci_create_qp + ci_create_spl_qp
+ ci_dealloc_mlnx_fmr + ci_deallocate_pd + ci_deregister_mr
+ ci_destroy_av + ci_destroy_cq + ci_destroy_mw
+ ci_destroy_qp + ci_detach_mcast + ci_enable_cq_notify
+ ci_enable_ncomp_cq_notify + ci_local_mad + ci_map_phys_mlnx_fmr
+ ci_modify_av + ci_modify_ca + ci_modify_mr
+ ci_modify_pmr + ci_modify_qp + ci_open_ca
+ ci_peek_cq + ci_poll_cq + ci_post_recv
+ ci_post_send + ci_query_av + ci_query_ca
+ ci_query_cq + ci_query_mr + ci_query_mw
+ ci_query_qp + ci_register_mr + ci_register_pmr
+ ci_register_smr + ci_resize_cq + ci_um_close_ca_t
+ ci_um_open_ca + ci_unmap_mlnx_fmr + ci_vendor_call
+ cl_alloc_relations + cl_async_proc_construct + cl_async_proc_destroy
+ cl_async_proc_init + cl_async_proc_queue + cl_atomic_add
+ cl_atomic_comp_xchg + cl_atomic_dec + cl_atomic_inc
+ cl_atomic_sub + cl_atomic_xchg + cl_break
+ cl_check_for_read + cl_check_for_write + cl_copy_from_user
+ cl_copy_to_user + cl_cpool_construct + cl_cpool_count
+ cl_cpool_destroy + cl_cpool_get + cl_cpool_grow
+ cl_cpool_init + cl_cpool_put + cl_dbg_out
+ cl_do_remove + cl_do_sync_pnp + cl_event_construct
+ cl_event_destroy + cl_event_init + cl_event_reset
+ cl_event_signal + cl_event_wait_on + cl_fmap_apply_func
+ cl_fmap_count + cl_fmap_delta + cl_fmap_end
+ cl_fmap_get + cl_fmap_head + cl_fmap_init
+ cl_fmap_insert + cl_fmap_key + cl_fmap_merge
+ cl_fmap_next + cl_fmap_prev + cl_fmap_remove
+ cl_fmap_remove_all + cl_fmap_remove_item + cl_fmap_tail
+ cl_free + cl_fwd_query_ifc + cl_get_pagesize
+ cl_get_physaddr + cl_get_tick_count + cl_get_tick_freq
+ cl_get_time_stamp + cl_get_time_stamp_sec + cl_get_time_stamp_usec
+ cl_hton16 + cl_hton32 + cl_hton64
+ cl_init_pnp_po_ext + cl_ioctl_cmd + cl_ioctl_complete
+ cl_ioctl_ctl_code + cl_ioctl_in_buf + cl_ioctl_in_size
+ cl_ioctl_out_buf + cl_ioctl_out_size + cl_ioctl_process
+ cl_ioctl_request + cl_ioctl_result + cl_ioctl_type
+ cl_irp_complete + cl_irp_ignore + cl_irp_skip
+ cl_irp_succeed + cl_irp_unsupported + cl_irqlock_acquire
+ cl_irqlock_construct + cl_irqlock_destroy + cl_irqlock_init
+ cl_irqlock_release + cl_is_blockable + cl_is_cpool_inited
+ cl_is_fmap_empty + cl_is_item_in_qlist + cl_is_list_empty
+ cl_is_list_inited + cl_is_map_empty + cl_is_map_inited
+ cl_is_object_in_list + cl_is_pool_inited + cl_is_qcpool_inited
+ cl_is_qlist_empty + cl_is_qmap_empty + cl_is_qpool_inited
+ cl_is_rbmap_empty + cl_is_sys_callback_inited + cl_list_apply_func
+ cl_list_construct + cl_list_count + cl_list_destroy
+ cl_list_end + cl_list_find_from_head + cl_list_find_from_tail
+ cl_list_head + cl_list_init + cl_list_insert_array_head
+ cl_list_insert_array_tail + cl_list_insert_head + cl_list_insert_next
+ cl_list_insert_prev + cl_list_insert_tail + cl_list_next
+ cl_list_obj + cl_list_prev + cl_list_remove_all
+ cl_list_remove_head + cl_list_remove_item + cl_list_remove_object
+ cl_list_remove_tail + cl_list_tail + cl_log_event
+ cl_malloc + cl_map_construct + cl_map_count
+ cl_map_delta + cl_map_destroy + cl_map_end
+ cl_map_get + cl_map_head + cl_map_init
+ cl_map_insert + cl_map_key + cl_map_merge
+ cl_map_next + cl_map_obj + cl_map_prev
+ cl_map_remove + cl_map_remove_all + cl_map_remove_item
+ cl_map_tail + cl_mem_display + cl_memclr
+ cl_memcmp + cl_memcpy + cl_memset
+ cl_msg_out + cl_mutex_acquire + cl_mutex_construct
+ cl_mutex_destroy + cl_mutex_init + cl_mutex_release
+ cl_ntoh + cl_ntoh16 + cl_ntoh32
+ cl_ntoh64 + cl_obj_construct + cl_obj_deinit
+ cl_obj_deref + cl_obj_destroy + cl_obj_init
+ cl_obj_insert_rel + cl_obj_insert_rel_parent_locked + cl_obj_lock
+ cl_obj_mgr_create + cl_obj_mgr_destroy + cl_obj_ref
+ cl_obj_remove_rel + cl_obj_reset + cl_obj_type
+ cl_obj_unlock + cl_palloc + cl_panic
+ cl_perf_construct + cl_perf_destroy + cl_perf_display
+ cl_perf_init + cl_perf_reset + cl_plock_acquire
+ cl_plock_construct + cl_plock_destroy + cl_plock_excl_acquire
+ cl_plock_init + cl_plock_release + cl_pnp
+ cl_pool_construct + cl_pool_count + cl_pool_destroy
+ cl_pool_get + cl_pool_grow + cl_pool_init
+ cl_pool_put + cl_power + cl_proc_count
+ cl_ptr_vector_apply_func + cl_ptr_vector_at + cl_ptr_vector_construct
+ cl_ptr_vector_destroy + cl_ptr_vector_find_from_end + cl_ptr_vector_find_from_start
+ cl_ptr_vector_get + cl_ptr_vector_get_capacity + cl_ptr_vector_get_size
+ cl_ptr_vector_init + cl_ptr_vector_insert + cl_ptr_vector_remove
+ cl_ptr_vector_set + cl_ptr_vector_set_capacity + cl_ptr_vector_set_min_size
+ cl_ptr_vector_set_size + cl_pzalloc + cl_qcpool_construct
+ cl_qcpool_count + cl_qcpool_destroy + cl_qcpool_get
+ cl_qcpool_grow + cl_qcpool_init + cl_qcpool_put
+ cl_qcpool_put_list + cl_qlist_apply_func + cl_qlist_count
+ cl_qlist_end + cl_qlist_find_from_head + cl_qlist_find_from_tail
+ cl_qlist_find_next + cl_qlist_find_prev + cl_qlist_head
+ cl_qlist_init + cl_qlist_insert_array_head + cl_qlist_insert_array_tail
+ cl_qlist_insert_head + cl_qlist_insert_list_head + cl_qlist_insert_list_tail
+ cl_qlist_insert_next + cl_qlist_insert_prev + cl_qlist_insert_tail
+ cl_qlist_move_items + cl_qlist_next + cl_qlist_obj
+ cl_qlist_prev + cl_qlist_remove_all + cl_qlist_remove_head
+ cl_qlist_remove_item + cl_qlist_remove_tail + cl_qlist_set_obj
+ cl_qlist_tail + cl_qlock_pool_construct + cl_qlock_pool_destroy
+ cl_qlock_pool_get + cl_qlock_pool_init + cl_qlock_pool_put
+ cl_qmap_apply_func + cl_qmap_count + cl_qmap_delta
+ cl_qmap_end + cl_qmap_get + cl_qmap_head
+ cl_qmap_init + cl_qmap_insert + cl_qmap_key
+ cl_qmap_merge + cl_qmap_next + cl_qmap_obj
+ cl_qmap_prev + cl_qmap_remove + cl_qmap_remove_all
+ cl_qmap_remove_item + cl_qmap_set_obj + cl_qmap_tail
+ cl_qpool_construct + cl_qpool_count + cl_qpool_destroy
+ cl_qpool_get + cl_qpool_grow + cl_qpool_init
+ cl_qpool_put + cl_qpool_put_list + cl_rbmap_count
+ cl_rbmap_end + cl_rbmap_init + cl_rbmap_insert
+ cl_rbmap_left + cl_rbmap_remove_item + cl_rbmap_reset
+ cl_rbmap_right + cl_rbmap_root + cl_rel_alloc
+ cl_rel_free + cl_req_mgr_construct + cl_req_mgr_destroy
+ cl_req_mgr_get + cl_req_mgr_init + cl_req_mgr_resume
+ cl_rollback_pnp_state + cl_set_pnp_state + cl_spinlock_acquire
+ cl_spinlock_construct + cl_spinlock_destroy + cl_spinlock_init
+ cl_spinlock_release + cl_sys_callback_get + cl_sys_callback_put
+ cl_sys_callback_queue + cl_thread_pool_construct + cl_thread_pool_destroy
+ cl_thread_pool_init + cl_thread_pool_signal + cl_thread_stall
+ cl_thread_suspend + cl_timer_construct + cl_timer_destroy
+ cl_timer_init + cl_timer_start + cl_timer_stop
+ cl_timer_trim + cl_vector_apply_func + cl_vector_at
+ cl_vector_construct + cl_vector_destroy + cl_vector_find_from_end
+ cl_vector_find_from_start + cl_vector_get + cl_vector_get_capacity
+ cl_vector_get_ptr + cl_vector_get_size + cl_vector_init
+ cl_vector_set + cl_vector_set_capacity + cl_vector_set_min_size
+ cl_vector_set_size + cl_waitobj_create + cl_waitobj_deref
+ cl_waitobj_destroy + cl_waitobj_ref + cl_waitobj_reset
+ cl_waitobj_signal + cl_waitobj_wait_on + cl_zalloc
+ ib_class_is_vendor_specific + ib_class_is_vendor_specific_high + ib_class_is_vendor_specific_low
ib_dereg_svc + ib_deregister_ca
+ ib_dm_get_slot_lo_hi + ib_dm_set_slot_lo_hi ib_force_apm
+ ib_get_async_event_str ib_get_ca_by_gid
+ ib_get_err_str ib_get_guid
ib_get_mad_buf + ib_get_node_type_str ib_get_port_by_gid
+ ib_get_port_state_from_str + ib_get_port_state_str ib_get_query_node_rec ib_get_spl_qp + ib_get_wc_status_str
+ ib_get_wc_type_str + ib_get_wr_type_str + ib_gid_get_guid
+ ib_gid_get_subnet_prefix + ib_gid_is_link_local + ib_gid_is_site_local
+ ib_gid_set_default + ib_grh_get_ver_class_flow + ib_grh_set_ver_class_flow
+ ib_inform_get_dev_id + ib_inform_get_prod_type + ib_inform_get_qpn
+ ib_inform_get_resp_time_val + ib_inform_get_trap_num + ib_inform_get_vend_id
+ ib_inform_set_dev_id + ib_inform_set_prod_type + ib_inform_set_qpn
+ ib_inform_set_resp_time_val + ib_inform_set_trap_num + ib_inform_set_vend_id
ib_init_dgrm_svc + ib_iou_info_diag_dev_id + ib_iou_info_option_rom
+ ib_mad_init_new + ib_mad_init_response + ib_mad_is_response
+ ib_member_get_scope + ib_member_get_scope_state + ib_member_get_sl_flow_hop
+ ib_member_get_state + ib_member_set_join_state + ib_member_set_scope
+ ib_member_set_scope_state + ib_member_set_sl_flow_hop + ib_member_set_state
ib_modify_qp + ib_node_info_get_local_port_num + ib_node_info_get_vendor_id
+ ib_notice_get_count + ib_notice_get_dev_id + ib_notice_get_generic
+ ib_notice_get_prod_type + ib_notice_get_toggle + ib_notice_get_trap_num
+ ib_notice_get_type + ib_notice_get_vend_id + ib_notice_set_count
+ ib_notice_set_dev_id + ib_notice_set_generic + ib_notice_set_prod_type
+ ib_notice_set_toggle + ib_notice_set_trap_num + ib_notice_set_type
+ ib_notice_set_vend_id ib_open_al
+ ib_path_get_ipd + ib_path_rec_flow_lbl + ib_path_rec_hop_limit
+ ib_path_rec_init_local + ib_path_rec_mtu + ib_path_rec_mtu_sel
+ ib_path_rec_pkt_life + ib_path_rec_pkt_life_sel + ib_path_rec_rate
+ ib_path_rec_rate_sel + ib_path_rec_set_hop_flow_raw + ib_path_rec_sl
+ ib_pkey_get_base + ib_pkey_is_full_member ib_poll_cq
+ ib_port_info_compute_rate + ib_port_info_get_link_speed_active + ib_port_info_get_link_speed_sup
+ ib_port_info_get_lmc + ib_port_info_get_mpb + ib_port_info_get_mtu_cap
+ ib_port_info_get_neighbor_mtu + ib_port_info_get_op_vls + ib_port_info_get_port_state
+ +ib_port_info_get_sm_sl ib_port_info_get_vl_cap + ib_port_info_set_link_speed_sup -ib_port_info_set_lmc
+ +ib_port_info_set_lmc ib_port_info_set_mpb + ib_port_info_set_neighbor_mtu -ib_port_info_set_op_vls
+ +ib_port_info_set_op_vls ib_port_info_set_port_state -ib_port_info_set_state_no_change -ib_port_info_set_timeout +ib_port_info_set_sm_sl
+ib_port_info_set_state_no_change +ib_port_info_set_timeout ib_post_recv
ib_post_send ib_put_mad
ib_query
ib_query_av ib_query_ca
ib_query_ca_by_guid
ib_query_cq ib_query_mr
ib_query_mw
ib_query_qp ib_rearm_cq
ib_rearm_n_cq
ib_reg_ioc ib_reg_mad_pool
ib_reg_mad_svc
ib_reg_mem ib_reg_phys
ib_reg_pnp
ib_reg_shared ib_reg_shmid
ib_reg_svc +
ib_register_ca ib_reject_ioc
ib_remove_svc_entry
ib_rereg_mem ib_rereg_phys
+ ib_rmpp_is_flag_set +
ib_sa_mad_get_payload_ptr ib_send_mad
+ ib_slvl_table_get_vl -ib_slvl_table_set_vl -ib_sminfo_get_priority
+ +ib_slvl_table_set_vl +ib_sminfo_get_priority ib_sminfo_get_state -ib_smp_get_payload_ptr -ib_smp_get_status
+ +ib_smp_get_payload_ptr +ib_smp_get_status ib_smp_init_new -ib_smp_is_d -ib_smp_is_response
+ib_smp_is_d +ib_smp_is_response ib_subscribe -ib_switch_info_clear_state_change -ib_switch_info_get_state_change
+ib_switch_info_clear_state_change +ib_switch_info_get_state_change ib_sync_destroy
ib_unsubscribe + ib_vl_arb_element_get_vl
+ ib_vl_arb_element_set_vl +
ioc_at_slot mlnx_create_fmr
mlnx_destroy_fmr
mlnx_map_fmr mlnx_unmap_fmr
+ unsupported functions -uvp_bind_mw -uvp_get_interface
+ +uvp_bind_mw +uvp_get_interface uvp_peek_cq -uvp_poll_cq -uvp_post_allocate_pd_t
+ +uvp_poll_cq +uvp_post_allocate_pd_t uvp_post_attach_mcast_t -uvp_post_ci_call -uvp_post_close_ca_t
+ +uvp_post_ci_call +uvp_post_close_ca_t uvp_post_create_av_t -uvp_post_create_cq_t -uvp_post_create_mw_t
+ +uvp_post_create_cq_t +uvp_post_create_mw_t uvp_post_create_qp_t -uvp_post_deallocate_pd_t -uvp_post_destroy_av_t
+ +uvp_post_deallocate_pd_t +uvp_post_destroy_av_t uvp_post_destroy_cq_t -uvp_post_destroy_mw_t -uvp_post_destroy_qp_t
+ +uvp_post_destroy_mw_t +uvp_post_destroy_qp_t uvp_post_detach_mcast_t -uvp_post_modify_av_t -uvp_post_modify_ca_t
+ +uvp_post_modify_av_t +uvp_post_modify_ca_t uvp_post_modify_qp_t -uvp_post_open_ca_t -uvp_post_query_av_t
+ +uvp_post_open_ca_t +uvp_post_query_av_t uvp_post_query_ca_t -uvp_post_query_cq_t -uvp_post_query_mw_t
+ +uvp_post_query_cq_t +uvp_post_query_mw_t uvp_post_query_qp_t -uvp_post_recv -uvp_post_resize_cq_t
+ +uvp_post_recv +uvp_post_resize_cq_t uvp_post_send -uvp_pre_allocate_pd -uvp_pre_attach_mcast
+ +uvp_pre_allocate_pd +uvp_pre_attach_mcast uvp_pre_ci_call -uvp_pre_close_ca_t -uvp_pre_create_av
+ +uvp_pre_close_ca_t +uvp_pre_create_av uvp_pre_create_cq -uvp_pre_create_mw -uvp_pre_create_qp
+ +uvp_pre_create_mw +uvp_pre_create_qp uvp_pre_deallocate_pd -uvp_pre_destroy_av -uvp_pre_destroy_cq
+ +uvp_pre_destroy_av +uvp_pre_destroy_cq uvp_pre_destroy_mw -uvp_pre_destroy_qp -uvp_pre_detach_mcast
+ +uvp_pre_destroy_qp +uvp_pre_detach_mcast uvp_pre_modify_av -uvp_pre_modify_ca -uvp_pre_modify_qp
+ +uvp_pre_modify_ca +uvp_pre_modify_qp uvp_pre_open_ca_t -uvp_pre_query_av -uvp_pre_query_ca
+ +uvp_pre_query_av +uvp_pre_query_ca uvp_pre_query_cq -uvp_pre_query_mw -uvp_pre_query_qp
+ +uvp_pre_query_mw +uvp_pre_query_qp uvp_pre_resize_cq -uvp_rearm_cq -uvp_rearm_n_cq
+uvp_rearm_cq +uvp_rearm_n_cq
diff --git a/trunk/docs/robo_modules.html b/trunk/docs/robo_modules.html index b6132ac4..d06631d5 100644 --- a/trunk/docs/robo_modules.html +++ b/trunk/docs/robo_modules.html @@ -7,7 +7,7 @@ -Generated from ./inc/ with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/ with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

[Sourcefiles] @@ -20,104 +20,104 @@

Modules

+ + + + + + - + - - - + - - - - - - - - + - - - - + + - - + + - - - - - - - + - - - - - + - - - - - + - - - - - + - +
+ IO Unit Interface +Access Layer +AL Channel Interface +AL Interface Asynchronous Processor
Atomic Operations Byte Swapping + +Component Library Composite Pool + Constants
+
Debug Output + Event + Flexi Map -ib_al_ifc.h -ib_ci_ifc.h
-ioc_ifc.h + +IO Controler Interface IOCTL Object -iou_ifc.h -ipoib_ifc.h -Irqlock
+ +IPoIB Interface +Irqlock List + Log Provider + Map
Memory Management Mutex
+ Object -Overview -Overview -Overview user-mode Verbs + Passive Lock +Performance Counters
-Performance Counters + Plug and Play + Pointer Vector + Pool + Quick Composite Pool +Quick List
-Quick List + Quick Locking Pool + Quick Map + Quick Pool + RB Map +Request Manager
-Request Manager + Spinlock + System Callback + Thread Pool + Timer +Type Definitions
-Type Definitions +user-mode Verbs Vector diff --git a/trunk/docs/robo_sourcefiles.html b/trunk/docs/robo_sourcefiles.html index f10b94d2..ab5ac395 100644 --- a/trunk/docs/robo_sourcefiles.html +++ b/trunk/docs/robo_sourcefiles.html @@ -7,7 +7,7 @@ -Generated from ./inc/ with ROBODoc v4.99.17 on Sun Aug 27 2006 10:20:31 +Generated from ./inc/ with ROBODoc v4.99.17 on Sun Nov 12 2006 16:36:39

[Sourcefiles] @@ -151,6 +151,9 @@ ib_types.h

  • ./inc/kernel/