contrib/ofed/management/opensm/include/opensm/osm_pkey_mgr.h

   1 /*
   2  * Copyright (c) 2006 Voltaire, Inc. All rights reserved.
   3  * Copyright (c) 2002-2005 Mellanox Technologies LTD. All rights reserved.
   4  *
   5  * This software is available to you under a choice of one of two
   6  * licenses.  You may choose to be licensed under the terms of the GNU
   7  * General Public License (GPL) Version 2, available from the file
   8  * COPYING in the main directory of this source tree, or the
   9  * OpenIB.org BSD license below:
  10  *
  11  *     Redistribution and use in source and binary forms, with or
  12  *     without modification, are permitted provided that the following
  13  *     conditions are met:
  14  *
  15  *      - Redistributions of source code must retain the above
  16  *        copyright notice, this list of conditions and the following
  17  *        disclaimer.
  18  *
  19  *      - Redistributions in binary form must reproduce the above
  20  *        copyright notice, this list of conditions and the following
  21  *        disclaimer in the documentation and/or other materials
  22  *        provided with the distribution.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  31  * SOFTWARE.
  32  *
  33  */
  34
  35 /*
  36  * Abstract:
  37  *      Prototype for osm_pkey_mgr_process() function
  38  *      This is part of the OpenSM family of objects.
  39  */
  40
  41 #ifndef _OSM_PKEY_MGR_H_
  42 #define _OSM_PKEY_MGR_H_
  43
  44 #include <opensm/osm_base.h>
  45 #include <opensm/osm_opensm.h>
  46
  47 #ifdef __cplusplus
  48 #  define BEGIN_C_DECLS extern "C" {
  49 #  define END_C_DECLS   }
  50 #else                           /* !__cplusplus */
  51 #  define BEGIN_C_DECLS
  52 #  define END_C_DECLS
  53 #endif                          /* __cplusplus */
  54
  55 BEGIN_C_DECLS
  56 /****f* OpenSM: P_Key Manager/osm_pkey_mgr_process
  57 * NAME
  58 *       osm_pkey_mgr_process
  59 *
  60 * DESCRIPTION
  61 *       This function enforces the pkey rules on the SM DB.
  62 *
  63 * SYNOPSIS
  64 */
  65 osm_signal_t osm_pkey_mgr_process(IN osm_opensm_t * p_osm);
  66 /*
  67 * PARAMETERS
  68 *       p_osm
  69 *               [in] Pointer to an osm_opensm_t object.
  70 *
  71 * RETURN VALUES
  72 *       None
  73 *
  74 * NOTES
  75 *
  76 * SEE ALSO
  77 *********/
  78
  79 END_C_DECLS
  80 #endif                          /* _OSM_PKEY_MGR_H_ */