80 #ifndef _CL_HANDLE_API_H_
81 #define _CL_HANDLE_API_H_
95 #define CL_HANDLE_INVALID_VALUE 0x0
96 #define CL_HDL_IDX_MASK 0x00000000FFFFFFFFULL
97 #define CL_HDL_IDX(hdl) (ClUint32T)( (hdl) & CL_HDL_IDX_MASK)
99 #define CL_HDL_NODE_ADDR_MASK 0xFFF0000000000000ULL
100 #define CL_HDL_PORT_ADDR_MASK 0x000FFF0000000000ULL
101 #define CL_HDL_DB_ADDR_MASK 0x000000FF00000000ULL
103 #define CL_HDL_NODE_ADDR(hdl) ((((ClUint64T)hdl)&CL_HDL_NODE_ADDR_MASK)>>52)
104 #define CL_HDL_PORT_ADDR(hdl) ((((ClUint64T)hdl)&CL_HDL_PORT_ADDR_MASK)>>40)
105 #define CL_HDL_DB_ADDR(hdl) ((((ClUint64T)hdl)&CL_HDL_DB_ADDR_MASK)>>32)
146 CL_IN void (*destructor)(
void*),
214 CL_IN ClInt32T instanceSize,
215 CL_OUT ClHandleT *handle);
256 CL_IN ClInt32T instance_size,
258 CL_OUT ClHandleT *handle_out);
298 CL_IN ClHandleT handle);
335 CL_IN ClHandleT handle,
370 CL_IN ClHandleT handle);
372 extern ClRcT clHandleMove(
374 CL_IN ClHandleT oldHandle,
375 CL_IN ClHandleT newHandle);
Typical defines found in any software project.
Header file of Ioc Data Structures and APIs.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
#define CL_OUT
CL_OUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:110
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
ClRcT clHandleWithAddressCreate(CL_IN ClHandleDatabaseHandleT databaseHandle, CL_IN ClInt32T instance_size, CL_IN ClIocPhysicalAddressT compAddr, CL_OUT ClHandleT *handle_out)
Creates a handle with component address.
ClRcT clHandleDatabaseDestroy(CL_IN ClHandleDatabaseHandleT databaseHandle)
Destroys a handle database.
ClRcT clHandleDestroy(CL_IN ClHandleDatabaseHandleT databaseHandle, CL_IN ClHandleT handle)
Destroy a handle.
ClRcT clHandleDatabaseCreate(CL_IN void(*destructor)(void *), CL_OUT ClHandleDatabaseHandleT *databaseHandle)
Creates a handle database.
ClWordT clHandleGetDatabaseId(ClHandleDatabaseHandleT *databaseHandle)
Get the handle database Identifier.
ClRcT clHandleCreate(CL_IN ClHandleDatabaseHandleT databaseHandle, CL_IN ClInt32T instanceSize, CL_OUT ClHandleT *handle)
Creates a handle.
ClRcT clHandleCheckout(CL_IN ClHandleDatabaseHandleT databaseHandle, CL_IN ClHandleT handle, CL_OUT void **instance)
Check out a handle.
ClRcT clHandleCheckin(CL_IN ClHandleDatabaseHandleT databaseHandle, CL_IN ClHandleT handle)
Check in a handle.
ClPtrT ClHandleDatabaseHandleT
Handle database handle.
Definition: clHandleApi.h:110
The IOC Physical address of an application's communication end point.
Definition: clIocApi.h:383