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 */ 30 31 #ifndef _BHND_NVRAM_BHND_NVRAM_IO_H_ 32 #define _BHND_NVRAM_BHND_NVRAM_IO_H_ 33 34 #ifdef _KERNEL 35 #include <sys/param.h> 36 37 #include <dev/bhnd/bhnd.h> 38 #else /* !_KERNEL */ 39 #include <errno.h> 40 41 #include <stdbool.h> 42 #include <stdint.h> 43 #include <stdlib.h> 44 #endif /* _KERNEL */ 45 46 struct bhnd_nvram_io; 47 48 struct bhnd_nvram_io *bhnd_nvram_iobuf_new(const void *buffer, size_t size); 49 struct bhnd_nvram_io *bhnd_nvram_iobuf_empty(size_t size, size_t capacity); 50 struct bhnd_nvram_io *bhnd_nvram_iobuf_copy(struct bhnd_nvram_io *src); 51 struct bhnd_nvram_io *bhnd_nvram_iobuf_copy_range(struct bhnd_nvram_io *src, 52 size_t offset, size_t size); 53 54 struct bhnd_nvram_io *bhnd_nvram_ioptr_new(const void *ptr, size_t size, 55 size_t capacity, uint32_t flags); 56 57 #ifdef _KERNEL 58 struct bhnd_nvram_io *bhnd_nvram_iores_new(struct bhnd_resource *r, 59 bus_size_t offset, bus_size_t size, 60 u_int bus_width); 61 #endif /* _KERNEL */ 62 63 size_t bhnd_nvram_io_getsize(struct bhnd_nvram_io *io); 64 int bhnd_nvram_io_setsize(struct bhnd_nvram_io *io, 65 size_t size); 66 67 int bhnd_nvram_io_read(struct bhnd_nvram_io *io, 68 size_t offset, void *buffer, size_t nbytes); 69 int bhnd_nvram_io_read_ptr(struct bhnd_nvram_io *io, 70 size_t offset, const void **ptr, size_t nbytes, 71 size_t *navail); 72 73 int bhnd_nvram_io_write(struct bhnd_nvram_io *io, 74 size_t offset, void *buffer, size_t nbytes); 75 int bhnd_nvram_io_write_ptr(struct bhnd_nvram_io *io, 76 size_t offset, void **ptr, size_t nbytes, 77 size_t *navail); 78 79 void bhnd_nvram_io_free(struct bhnd_nvram_io *io); 80 81 /** 82 * bhnd_nvram_ioptr flags 83 */ 84 enum { 85 BHND_NVRAM_IOPTR_RDONLY = (1<<0), /**< read-only */ 86 BHND_NVRAM_IOPTR_RDWR = (1<<1), /**< read/write */ 87 }; 88 89 #endif /* _BHND_NVRAM_BHND_NVRAM_IO_H_ */ 90