usr/src/lib/libfru/include/libfrup.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 #ifndef _LIBFRUP_H
  27 #define _LIBFRUP_H
  28
  29 #pragma ident   "%Z%%M% %I%     %E% SMI"
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #include <stdarg.h>
  36
  37 #include "libfru.h"
  38 #include "../../libfruutils/fru_tag.h"
  39
  40 typedef uint64_t fru_seghdl_t;
  41 typedef enum {FRU_ENCRYPT, FRU_DECRYPT} fru_encrypt_t;
  42 typedef fru_errno_t
  43 (*fru_encrypt_func_t)(fru_encrypt_t en_dec, unsigned char *buf, size_t buf_len);
  44
  45 /*
  46  * Type for pointers to functions for terminating the processing of a node
  47  * (after its children have been processed)
  48  */
  49 typedef void    (*end_node_fp_t)(fru_nodehdl_t node, const char *path,
  50                                         const char *name, void *args);
  51
  52 /*
  53  * Project-private exported symbols
  54  */
  55 extern  fru_encrypt_func_t encrypt_func;
  56
  57 extern  fru_errno_t fru_encryption_supported(void);
  58
  59 extern  fru_errno_t fru_walk_tree(fru_nodehdl_t node, const char *prior_path,
  60                 fru_errno_t (*process_node)(fru_nodehdl_t node,
  61                                                 const char *path,
  62                                                 const char *name, void *args,
  63                                                 end_node_fp_t *end_node,
  64                                                 void **end_args),
  65                 void *args);
  66
  67 extern  int fru_pathmatch(const char *path, const char *searchpath);
  68
  69 extern  fru_errno_t fru_for_each_segment(fru_nodehdl_t node,
  70                                         int (*function)(fru_seghdl_t segment,
  71                                                 void *args),
  72                                         void *args);
  73 extern  fru_errno_t fru_get_segment_name(fru_seghdl_t segment, char **name);
  74 extern  fru_errno_t fru_for_each_packet(fru_seghdl_t segment,
  75                                 int (*function)(fru_tag_t *tag,
  76                                                 uint8_t *payload,
  77                                                 size_t length, void *args),
  78                                 void *args);
  79
  80 #ifdef __cplusplus
  81 }
  82 #endif
  83
  84 #endif /* _LIBFRUP_H */