drivers/net/npe/include/IxNpeMhUnsolicitedCbMgr_p.h

   1 /**
   2  * @file IxNpeMhUnsolicitedCbMgr_p.h
   3  *
   4  * @author Intel Corporation
   5  * @date 18 Jan 2002
   6  *
   7  * @brief This file contains the private API for the Unsolicited Callback
   8  * Manager module.
   9  *
  10  *
  11  * @par
  12  * IXP400 SW Release version 2.0
  13  *
  14  * -- Copyright Notice --
  15  *
  16  * @par
  17  * Copyright 2001-2005, Intel Corporation.
  18  * All rights reserved.
  19  *
  20  * @par
  21  * SPDX-License-Identifier:     BSD-3-Clause
  22  * @par
  23  * -- End of Copyright Notice --
  24  */
  25
  26 /**
  27  * @defgroup IxNpeMhUnsolicitedCbMgr_p IxNpeMhUnsolicitedCbMgr_p
  28  *
  29  * @brief The private API for the Unsolicited Callback Manager module.
  30  *
  31  * @{
  32  */
  33
  34 #ifndef IXNPEMHUNSOLICITEDCBMGR_P_H
  35 #define IXNPEMHUNSOLICITEDCBMGR_P_H
  36
  37 #include "IxNpeMh.h"
  38 #include "IxOsalTypes.h"
  39
  40 /*
  41  * #defines for function return types, etc.
  42  */
  43
  44 /*
  45  * Prototypes for interface functions.
  46  */
  47
  48 /**
  49  * @fn void ixNpeMhUnsolicitedCbMgrInitialize (void)
  50  *
  51  * @brief This function initializes the Unsolicited Callback Manager
  52  * module, setting up a callback data structure for each NPE.
  53  *
  54  * @return No return value.
  55  */
  56
  57 void ixNpeMhUnsolicitedCbMgrInitialize (void);
  58
  59 /**
  60  * @fn void ixNpeMhUnsolicitedCbMgrCallbackSave (
  61            IxNpeMhNpeId npeId,
  62            IxNpeMhMessageId unsolicitedMessageId,
  63            IxNpeMhCallback unsolicitedCallback)
  64  *
  65  * @brief This function saves a callback in the specified NPE's callback
  66  * table.  If a callback already exists for the specified ID then it will
  67  * be overwritten.
  68  *
  69  * @param IxNpeMhNpeId npeId (in) - The ID of the NPE in whose callback
  70  * table the callback will be saved.
  71  * @param IxNpeMhMessageId unsolicitedMessageId (in) - The ID of the
  72  * messages that this callback is for.
  73  * @param IxNpeMhCallback unsolicitedCallback (in) - The callback function
  74  * pointer to save.
  75  *
  76  * @return No return value.
  77  */
  78
  79 void ixNpeMhUnsolicitedCbMgrCallbackSave (
  80     IxNpeMhNpeId npeId,
  81     IxNpeMhMessageId unsolicitedMessageId,
  82     IxNpeMhCallback unsolicitedCallback);
  83
  84 /**
  85  * @fn void ixNpeMhUnsolicitedCbMgrCallbackRetrieve (
  86            IxNpeMhNpeId npeId,
  87            IxNpeMhMessageId unsolicitedMessageId,
  88            IxNpeMhCallback *unsolicitedCallback)
  89  *
  90  * @brief This function retrieves the callback for the specified ID from
  91  * the specified NPE's callback table.  If no callback is registered for
  92  * the specified ID and NPE then a callback value of NULL will be returned.
  93  *
  94  * @param IxNpeMhNpeId npeId (in) - The ID of the NPE from whose callback
  95  * table the callback will be retrieved.
  96  * @param IxNpeMhMessageId unsolicitedMessageId (in) - The ID of the
  97  * messages that the callback is for.
  98  * @param IxNpeMhCallback unsolicitedCallback (out) - The callback function
  99  * pointer retrieved.
 100  *
 101  * @return No return value.
 102  */
 103
 104 void ixNpeMhUnsolicitedCbMgrCallbackRetrieve (
 105     IxNpeMhNpeId npeId,
 106     IxNpeMhMessageId unsolicitedMessageId,
 107     IxNpeMhCallback *unsolicitedCallback);
 108
 109 /**
 110  * @fn void ixNpeMhUnsolicitedCbMgrShow (
 111            IxNpeMhNpeId npeId)
 112  *
 113  * @brief This function will display the current state of the Unsolicited
 114  * Callback Manager module.
 115  *
 116  * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
 117  * information for.
 118  *
 119  * @return No return value.
 120  */
 121
 122 void ixNpeMhUnsolicitedCbMgrShow (
 123     IxNpeMhNpeId npeId);
 124
 125 /**
 126  * @fn void ixNpeMhUnsolicitedCbMgrShowReset (
 127            IxNpeMhNpeId npeId)
 128  *
 129  * @brief This function will reset the current state of the Unsolicited
 130  * Callback Manager module.
 131  *
 132  * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
 133  * information for.
 134  *
 135  * @return No return value.
 136  */
 137
 138 void ixNpeMhUnsolicitedCbMgrShowReset (
 139     IxNpeMhNpeId npeId);
 140
 141 #endif /* IXNPEMHUNSOLICITEDCBMGR_P_H */
 142
 143 /**
 144  * @} defgroup IxNpeMhUnsolicitedCbMgr_p
 145  */