src/include/gpxe/nvo.h

   1 #ifndef _GPXE_NVO_H
   2 #define _GPXE_NVO_H
   3
   4 /** @file
   5  *
   6  * Non-volatile stored options
   7  *
   8  */
   9
  10 #include <stdint.h>
  11 #include <gpxe/dhcpopts.h>
  12 #include <gpxe/settings.h>
  13
  14 struct nvs_device;
  15 struct refcnt;
  16
  17 /**
  18  * A fragment of a non-volatile storage device used for stored options
  19  */
  20 struct nvo_fragment {
  21         /** Starting address of fragment within NVS device */
  22         unsigned int address;
  23         /** Length of fragment */
  24         size_t len;
  25 };
  26
  27 /**
  28  * A block of non-volatile stored options
  29  */
  30 struct nvo_block {
  31         /** Settings block */
  32         struct settings settings;
  33         /** Underlying non-volatile storage device */
  34         struct nvs_device *nvs;
  35         /** List of option-containing fragments
  36          *
  37          * The list is terminated by a fragment with a length of zero.
  38          */
  39         struct nvo_fragment *fragments;
  40         /** Total length of option-containing fragments */
  41         size_t total_len;
  42         /** Option-containing data */
  43         void *data;
  44         /** DHCP options block */
  45         struct dhcp_options dhcpopts;
  46 };
  47
  48 extern void nvo_init ( struct nvo_block *nvo, struct nvs_device *nvs,
  49                        struct nvo_fragment *fragments, struct refcnt *refcnt );
  50 extern int register_nvo ( struct nvo_block *nvo, struct settings *parent );
  51 extern void unregister_nvo ( struct nvo_block *nvo );
  52
  53 #endif /* _GPXE_NVO_H */