TABLE OF CONTENTS

1. Component Library System Helper/__cl_syshelper_exit
2. Component Library System Helper/__cl_syshelper_init
3. Component Library System Helper/__cl_user_syshelper_exit
4. Component Library System Helper/cl_helper_objects_t
5. Component Library System Helper/cl_phy_io_addr_space_t
6. Component Library System Helper/cl_shared_buf_obj_t
7. Component Library System Helper/cl_syshelper_obj_ctxt_t
8. Component Library System Helper/define_io_space
9. Component Library System Helper/is_io_space
10. Component Library System Helper/pfn_cleanup_on_close
11. Component Library System Helper/syshelper_cleanup_sh_buf
12. Component Library/System Helper

Component Library System Helper/__cl_syshelper_exit

    __cl_syshelper_exit

void
__cl_syshelper_exit(void);

    None

    None.

    system_helper_init

Component Library System Helper/__cl_syshelper_init

    __cl_syshelper_init

    Initializes the system helper data structures and prepares it
    for use.

cl_status_t
__cl_syshelper_init(void);

    None.

    TBD

    system_helper_exit

Component Library System Helper/__cl_user_syshelper_exit

    __cl_user_syshelper_exit

    Cleanup the system helper in user mode.

void
__cl_user_syshelper_exit(void);

    None.

    None.

#endif      // __KERNEL__

 Shared between user and kernel mode.
/
***d* Component Library System Helper/cl_syshelper_ops_t

Component Library System Helper/cl_helper_objects_t

    cl_helper_objects_t

    Enumerates the different helper object types. 

typedef enum _cl_helper_objects 
{
    WAIT_OBJECT = 0,
    SHARED_BUFFER_OBJECT,

    LAST_HELPER_OBJECT      /* should always be at the end */

} cl_helper_objects_t;

    WAIT_OBJECT
        Indicates object is a wait object.
    SHARED_BUFFER_OBJECT
        Indicates object is a shared buffer.
    LAST_HELPER_OBJECT
        Maximum number of objects.

Component Library System Helper/cl_phy_io_addr_space_t

    cl_phy_io_addr_space_t

typedef struct cl_phy_io_addr_space
{
    cl_list_item_t  list_item;
    uintn_t         base;
    uintn_t         length;

} cl_phy_io_addr_space_t;

Component Library System Helper/cl_shared_buf_obj_t

    cl_shared_buf_obj_t

typedef struct cl_shared_buf_obj 
{
    cl_list_item_t  list_item;
    void            *kernel_buffer;
    void            *user_address;
    uint32_t        num_pages;

} cl_shared_buf_obj_t;

Component Library System Helper/cl_syshelper_obj_ctxt_t

    cl_syshelper_obj_ctxt_t

typedef struct cl_syshelper_obj_ctxt
{
    /* Per-open object context list */
    cl_map_item_t   map_item;
    cl_qmap_t       sysdev_hmap;
    cl_plock_t      sysdev_plock;
    cl_qlist_t      obj_context_list[LAST_HELPER_OBJECT];

} cl_syshelper_obj_ctxt_t;

Component Library System Helper/define_io_space

    define_io_space

    This function lets a verbs provider driver declare its global IO
    space. This is used by memory mapping utils to figure out if a virtual
    address belongs to IO space.

 
cl_status_t
define_io_space(
    IN uintn_t  virtual_address,
    IN uintn_t  length );

    None.

    TBD

Component Library System Helper/is_io_space

    is_io_space

    This function checks to see if the virtual address (input
    parameter) is in I/O space.

boolean_t
is_io_space(
    IN uintn_t virtual_address );

    None.

    TBD

Component Library System Helper/pfn_cleanup_on_close

    pfn_cleanup_on_close

    Function prototype for cleanup call when close is called 
    on the  file descriptor

typedef void 
(*pfn_cleanup_on_close)(
    IN void *p_object_context_qlist );

    p_object_context_qlist
        [in] The Qlist that is passed in as a context to this
             function.

    None.

Component Library System Helper/syshelper_cleanup_sh_buf

    syshelper_cleanup_sh_buf

    Function to cleanup a shared buffer.

cl_status_t
syshelper_cleanup_sh_buf(
    IN cl_shared_buf_obj_t *p_shared_buf );

void *
__cl_insert_sysdev_hmap(
    IN  cl_qmap_t           *p_map,
    IN  cl_map_item_t       *p_map_item,
    IN  cl_plock_t          *p_lock,
    IN  void                *p_object);

void *
__cl_remove_sysdev_hmap(
    IN  cl_qmap_t           *p_map,
    IN  cl_plock_t          *p_lock,
    IN  void                *p_object);

void *
__cl_find_sysdev_hmap(
    IN  cl_qmap_t           *p_map,
    IN  cl_plock_t          *p_lock,
    IN  void                *p_object);
#else       // __KERNEL__

 
 User mode only 
/

Component Library/System Helper

    System Helper

    Provides various system helper utilities like wait objects, 
    shared buffer and asynchronous procedure calls.