sys/dev/bhnd/nvram/bhnd_nvram_io.h

   1 /*-
   2  * Copyright (c) 2016 Landon Fuller <landonf@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer,
  10  *    without modification.
  11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  13  *    redistribution must be conditioned upon including a substantially
  14  *    similar Disclaimer requirement for further binary redistribution.
  15  *
  16  * NO WARRANTY
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  27  * THE POSSIBILITY OF SUCH DAMAGES.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _BHND_NVRAM_BHND_NVRAM_IO_H_
  33 #define _BHND_NVRAM_BHND_NVRAM_IO_H_
  34
  35 #ifdef _KERNEL
  36 #include <sys/param.h>
  37
  38 #include <dev/bhnd/bhnd.h>
  39 #else /* !_KERNEL */
  40 #include <errno.h>
  41
  42 #include <stdbool.h>
  43 #include <stdint.h>
  44 #include <stdlib.h>
  45 #endif /* _KERNEL */
  46
  47 struct bhnd_nvram_io;
  48
  49 struct bhnd_nvram_io    *bhnd_nvram_iobuf_new(const void *buffer, size_t size);
  50 struct bhnd_nvram_io    *bhnd_nvram_iobuf_empty(size_t size, size_t capacity);
  51 struct bhnd_nvram_io    *bhnd_nvram_iobuf_copy(struct bhnd_nvram_io *src);
  52 struct bhnd_nvram_io    *bhnd_nvram_iobuf_copy_range(struct bhnd_nvram_io *src,
  53                              size_t offset, size_t size);
  54
  55 struct bhnd_nvram_io    *bhnd_nvram_ioptr_new(const void *ptr, size_t size,
  56                              size_t capacity, uint32_t flags);
  57
  58 #ifdef _KERNEL
  59 struct bhnd_nvram_io    *bhnd_nvram_iores_new(struct bhnd_resource *r,
  60                              bus_size_t offset, bus_size_t size,
  61                              u_int bus_width);
  62 #endif /* _KERNEL */
  63
  64 size_t                   bhnd_nvram_io_getsize(struct bhnd_nvram_io *io);
  65 int                      bhnd_nvram_io_setsize(struct bhnd_nvram_io *io,
  66                              size_t size);
  67
  68 int                      bhnd_nvram_io_read(struct bhnd_nvram_io *io,
  69                              size_t offset, void *buffer, size_t nbytes);
  70 int                      bhnd_nvram_io_read_ptr(struct bhnd_nvram_io *io,
  71                              size_t offset, const void **ptr, size_t nbytes,
  72                              size_t *navail);
  73
  74 int                      bhnd_nvram_io_write(struct bhnd_nvram_io *io,
  75                              size_t offset, void *buffer, size_t nbytes);
  76 int                      bhnd_nvram_io_write_ptr(struct bhnd_nvram_io *io,
  77                              size_t offset, void **ptr, size_t nbytes,
  78                              size_t *navail);
  79
  80 void                     bhnd_nvram_io_free(struct bhnd_nvram_io *io);
  81
  82 /**
  83  * bhnd_nvram_ioptr flags
  84  */
  85 enum {
  86         BHND_NVRAM_IOPTR_RDONLY = (1<<0),       /**< read-only */
  87         BHND_NVRAM_IOPTR_RDWR   = (1<<1),       /**< read/write */
  88 };
  89
  90 #endif /* _BHND_NVRAM_BHND_NVRAM_IO_H_ */