1f76db8deSLandon J. Fuller /*-
2f76db8deSLandon J. Fuller * Copyright (c) 2016 Landon Fuller <landonf@FreeBSD.org>
3f76db8deSLandon J. Fuller * All rights reserved.
4f76db8deSLandon J. Fuller *
5f76db8deSLandon J. Fuller * Redistribution and use in source and binary forms, with or without
6f76db8deSLandon J. Fuller * modification, are permitted provided that the following conditions
7f76db8deSLandon J. Fuller * are met:
8f76db8deSLandon J. Fuller * 1. Redistributions of source code must retain the above copyright
9f76db8deSLandon J. Fuller * notice, this list of conditions and the following disclaimer,
10f76db8deSLandon J. Fuller * without modification.
11f76db8deSLandon J. Fuller * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12f76db8deSLandon J. Fuller * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13f76db8deSLandon J. Fuller * redistribution must be conditioned upon including a substantially
14f76db8deSLandon J. Fuller * similar Disclaimer requirement for further binary redistribution.
15f76db8deSLandon J. Fuller *
16f76db8deSLandon J. Fuller * NO WARRANTY
17f76db8deSLandon J. Fuller * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18f76db8deSLandon J. Fuller * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19f76db8deSLandon J. Fuller * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20f76db8deSLandon J. Fuller * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21f76db8deSLandon J. Fuller * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22f76db8deSLandon J. Fuller * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23f76db8deSLandon J. Fuller * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24f76db8deSLandon J. Fuller * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25f76db8deSLandon J. Fuller * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26f76db8deSLandon J. Fuller * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27f76db8deSLandon J. Fuller * THE POSSIBILITY OF SUCH DAMAGES.
28f76db8deSLandon J. Fuller */
29f76db8deSLandon J. Fuller
30f76db8deSLandon J. Fuller #include <sys/cdefs.h>
31f76db8deSLandon J. Fuller #ifdef _KERNEL
32f76db8deSLandon J. Fuller #include <sys/param.h>
33f76db8deSLandon J. Fuller #include <sys/malloc.h>
34f76db8deSLandon J. Fuller #include <sys/systm.h>
35f76db8deSLandon J. Fuller #else /* !_KERNEL */
36f76db8deSLandon J. Fuller #include <errno.h>
37f76db8deSLandon J. Fuller #include <stdint.h>
38f76db8deSLandon J. Fuller #include <stdlib.h>
39f76db8deSLandon J. Fuller #include <string.h>
40f76db8deSLandon J. Fuller #endif /* _KERNEL */
41f76db8deSLandon J. Fuller
42f76db8deSLandon J. Fuller #include "bhnd_nvram_private.h"
43f76db8deSLandon J. Fuller
44f76db8deSLandon J. Fuller #include "bhnd_nvram_io.h"
45f76db8deSLandon J. Fuller #include "bhnd_nvram_iovar.h"
46f76db8deSLandon J. Fuller
47f76db8deSLandon J. Fuller /**
48f76db8deSLandon J. Fuller * Memory-backed NVRAM I/O context.
49f76db8deSLandon J. Fuller *
50f76db8deSLandon J. Fuller * ioptr instances are gauranteed to provide persistent references to its
51f76db8deSLandon J. Fuller * backing contigious memory via bhnd_nvram_io_read_ptr() and
52f76db8deSLandon J. Fuller * bhnd_nvram_io_write_ptr().
53f76db8deSLandon J. Fuller */
54f76db8deSLandon J. Fuller struct bhnd_nvram_ioptr {
55f76db8deSLandon J. Fuller struct bhnd_nvram_io io; /**< common I/O instance state */
56f76db8deSLandon J. Fuller void *ptr; /**< backing memory */
57f76db8deSLandon J. Fuller size_t size; /**< size at @p ptr */
58f76db8deSLandon J. Fuller size_t capacity; /**< capacity at @p ptr */
59f76db8deSLandon J. Fuller uint32_t flags; /**< flags (see BHND_NVRAM_IOPTR_*) */
60f76db8deSLandon J. Fuller };
61f76db8deSLandon J. Fuller
BHND_NVRAM_IOPS_DEFN(ioptr)62f76db8deSLandon J. Fuller BHND_NVRAM_IOPS_DEFN(ioptr)
63f76db8deSLandon J. Fuller
64f76db8deSLandon J. Fuller /**
65f76db8deSLandon J. Fuller * Allocate and return a new I/O context, mapping @p size bytes at @p ptr.
66f76db8deSLandon J. Fuller
67f76db8deSLandon J. Fuller * The caller is responsible for deallocating the returned I/O context via
68f76db8deSLandon J. Fuller * bhnd_nvram_io_free().
69f76db8deSLandon J. Fuller *
70f76db8deSLandon J. Fuller * @param ptr The pointer to be mapped by the returned I/O
71f76db8deSLandon J. Fuller * context. Must remain valid for the lifetime of
72f76db8deSLandon J. Fuller * the returned I/O context.
73f76db8deSLandon J. Fuller * @param size The total number of bytes mapped at @p ptr.
74f76db8deSLandon J. Fuller * @param capacity The maximum number of bytes that may be mapped
75f76db8deSLandon J. Fuller * at @p ptr via bhnd_nvram_ioptr_setsize().
76f76db8deSLandon J. Fuller * @param flags Access flags (see BHND_NVRAM_IOPTR_*).
77f76db8deSLandon J. Fuller *
78f76db8deSLandon J. Fuller * @retval bhnd_nvram_io success.
79f76db8deSLandon J. Fuller * @retval NULL allocation failed.
80f76db8deSLandon J. Fuller * @retval NULL the requested @p capacity is less than @p size.
81f76db8deSLandon J. Fuller */
82f76db8deSLandon J. Fuller struct bhnd_nvram_io *
83f76db8deSLandon J. Fuller bhnd_nvram_ioptr_new(const void *ptr, size_t size, size_t capacity,
84f76db8deSLandon J. Fuller uint32_t flags)
85f76db8deSLandon J. Fuller {
86f76db8deSLandon J. Fuller struct bhnd_nvram_ioptr *ioptr;
87f76db8deSLandon J. Fuller
88f76db8deSLandon J. Fuller /* Sanity check the capacity */
89f76db8deSLandon J. Fuller if (size > capacity)
90f76db8deSLandon J. Fuller return (NULL);
91f76db8deSLandon J. Fuller
92f76db8deSLandon J. Fuller /* Allocate I/O context */
93f76db8deSLandon J. Fuller ioptr = bhnd_nv_malloc(sizeof(*ioptr));
94f76db8deSLandon J. Fuller if (ioptr == NULL)
95f76db8deSLandon J. Fuller return (NULL);
96f76db8deSLandon J. Fuller
97f76db8deSLandon J. Fuller ioptr->io.iops = &bhnd_nvram_ioptr_ops;
98f76db8deSLandon J. Fuller ioptr->ptr = __DECONST(void *, ptr);
99f76db8deSLandon J. Fuller ioptr->size = size;
100f76db8deSLandon J. Fuller ioptr->capacity = capacity;
101f76db8deSLandon J. Fuller ioptr->flags = flags;
102f76db8deSLandon J. Fuller
103f76db8deSLandon J. Fuller return (&ioptr->io);
104f76db8deSLandon J. Fuller }
105f76db8deSLandon J. Fuller
106f76db8deSLandon J. Fuller static void
bhnd_nvram_ioptr_free(struct bhnd_nvram_io * io)107f76db8deSLandon J. Fuller bhnd_nvram_ioptr_free(struct bhnd_nvram_io *io)
108f76db8deSLandon J. Fuller {
109f76db8deSLandon J. Fuller bhnd_nv_free(io);
110f76db8deSLandon J. Fuller }
111f76db8deSLandon J. Fuller
112f76db8deSLandon J. Fuller static size_t
bhnd_nvram_ioptr_getsize(struct bhnd_nvram_io * io)113f76db8deSLandon J. Fuller bhnd_nvram_ioptr_getsize(struct bhnd_nvram_io *io)
114f76db8deSLandon J. Fuller {
115f76db8deSLandon J. Fuller struct bhnd_nvram_ioptr *ioptr = (struct bhnd_nvram_ioptr *)io;
116f76db8deSLandon J. Fuller return (ioptr->size);
117f76db8deSLandon J. Fuller }
118f76db8deSLandon J. Fuller
119f76db8deSLandon J. Fuller static int
bhnd_nvram_ioptr_setsize(struct bhnd_nvram_io * io,size_t size)120f76db8deSLandon J. Fuller bhnd_nvram_ioptr_setsize(struct bhnd_nvram_io *io, size_t size)
121f76db8deSLandon J. Fuller {
122f76db8deSLandon J. Fuller struct bhnd_nvram_ioptr *ioptr = (struct bhnd_nvram_ioptr *)io;
123f76db8deSLandon J. Fuller
124f76db8deSLandon J. Fuller /* Must be writable */
125f76db8deSLandon J. Fuller if (!(ioptr->flags & BHND_NVRAM_IOPTR_RDWR))
126f76db8deSLandon J. Fuller return (ENODEV);
127f76db8deSLandon J. Fuller
128f76db8deSLandon J. Fuller /* Can't exceed the actual capacity */
129f76db8deSLandon J. Fuller if (size > ioptr->capacity)
130f76db8deSLandon J. Fuller return (ENXIO);
131f76db8deSLandon J. Fuller
132f76db8deSLandon J. Fuller ioptr->size = size;
133f76db8deSLandon J. Fuller return (0);
134f76db8deSLandon J. Fuller }
135f76db8deSLandon J. Fuller
136f76db8deSLandon J. Fuller /* Common ioptr_(read|write)_ptr implementation */
137f76db8deSLandon J. Fuller static int
bhnd_nvram_ioptr_ptr(struct bhnd_nvram_ioptr * ioptr,size_t offset,void ** ptr,size_t nbytes,size_t * navail)138f76db8deSLandon J. Fuller bhnd_nvram_ioptr_ptr(struct bhnd_nvram_ioptr *ioptr, size_t offset, void **ptr,
139f76db8deSLandon J. Fuller size_t nbytes, size_t *navail)
140f76db8deSLandon J. Fuller {
141f76db8deSLandon J. Fuller size_t avail;
142f76db8deSLandon J. Fuller
143f76db8deSLandon J. Fuller /* Verify offset+nbytes fall within the buffer range */
144f76db8deSLandon J. Fuller if (offset > ioptr->size)
145f76db8deSLandon J. Fuller return (ENXIO);
146f76db8deSLandon J. Fuller
147f76db8deSLandon J. Fuller avail = ioptr->size - offset;
148f76db8deSLandon J. Fuller if (avail < nbytes)
149f76db8deSLandon J. Fuller return (ENXIO);
150f76db8deSLandon J. Fuller
151f76db8deSLandon J. Fuller /* Valid I/O range, provide a pointer to the buffer and the
152f76db8deSLandon J. Fuller * total count of available bytes */
153f76db8deSLandon J. Fuller *ptr = ((uint8_t *)ioptr->ptr) + offset;
154f76db8deSLandon J. Fuller if (navail != NULL)
155f76db8deSLandon J. Fuller *navail = avail;
156f76db8deSLandon J. Fuller
157f76db8deSLandon J. Fuller return (0);
158f76db8deSLandon J. Fuller }
159f76db8deSLandon J. Fuller
160f76db8deSLandon J. Fuller static int
bhnd_nvram_ioptr_read_ptr(struct bhnd_nvram_io * io,size_t offset,const void ** ptr,size_t nbytes,size_t * navail)161f76db8deSLandon J. Fuller bhnd_nvram_ioptr_read_ptr(struct bhnd_nvram_io *io, size_t offset,
162f76db8deSLandon J. Fuller const void **ptr, size_t nbytes, size_t *navail)
163f76db8deSLandon J. Fuller {
164f76db8deSLandon J. Fuller struct bhnd_nvram_ioptr *ioptr;
165f76db8deSLandon J. Fuller void *writep;
166f76db8deSLandon J. Fuller int error;
167f76db8deSLandon J. Fuller
168f76db8deSLandon J. Fuller ioptr = (struct bhnd_nvram_ioptr *) io;
169f76db8deSLandon J. Fuller
170f76db8deSLandon J. Fuller /* Return a pointer into our backing buffer */
171f76db8deSLandon J. Fuller error = bhnd_nvram_ioptr_ptr(ioptr, offset, &writep, nbytes, navail);
172f76db8deSLandon J. Fuller if (error)
173f76db8deSLandon J. Fuller return (error);
174f76db8deSLandon J. Fuller
175f76db8deSLandon J. Fuller *ptr = writep;
176f76db8deSLandon J. Fuller
177f76db8deSLandon J. Fuller return (0);
178f76db8deSLandon J. Fuller }
179f76db8deSLandon J. Fuller
180f76db8deSLandon J. Fuller static int
bhnd_nvram_ioptr_write_ptr(struct bhnd_nvram_io * io,size_t offset,void ** ptr,size_t nbytes,size_t * navail)181f76db8deSLandon J. Fuller bhnd_nvram_ioptr_write_ptr(struct bhnd_nvram_io *io, size_t offset,
182f76db8deSLandon J. Fuller void **ptr, size_t nbytes, size_t *navail)
183f76db8deSLandon J. Fuller {
184f76db8deSLandon J. Fuller struct bhnd_nvram_ioptr *ioptr;
185f76db8deSLandon J. Fuller
186f76db8deSLandon J. Fuller ioptr = (struct bhnd_nvram_ioptr *) io;
187f76db8deSLandon J. Fuller
188f76db8deSLandon J. Fuller /* Must be writable */
189f76db8deSLandon J. Fuller if (!(ioptr->flags & BHND_NVRAM_IOPTR_RDWR))
190f76db8deSLandon J. Fuller return (ENODEV);
191f76db8deSLandon J. Fuller
192f76db8deSLandon J. Fuller /* Return a pointer into our backing buffer */
193f76db8deSLandon J. Fuller return (bhnd_nvram_ioptr_ptr(ioptr, offset, ptr, nbytes, navail));
194f76db8deSLandon J. Fuller }
195f76db8deSLandon J. Fuller
196f76db8deSLandon J. Fuller static int
bhnd_nvram_ioptr_read(struct bhnd_nvram_io * io,size_t offset,void * buffer,size_t nbytes)197f76db8deSLandon J. Fuller bhnd_nvram_ioptr_read(struct bhnd_nvram_io *io, size_t offset, void *buffer,
198f76db8deSLandon J. Fuller size_t nbytes)
199f76db8deSLandon J. Fuller {
200f76db8deSLandon J. Fuller const void *ptr;
201f76db8deSLandon J. Fuller int error;
202f76db8deSLandon J. Fuller
203f76db8deSLandon J. Fuller /* Try to fetch a direct pointer for at least nbytes */
204f76db8deSLandon J. Fuller if ((error = bhnd_nvram_io_read_ptr(io, offset, &ptr, nbytes, NULL)))
205f76db8deSLandon J. Fuller return (error);
206f76db8deSLandon J. Fuller
207f76db8deSLandon J. Fuller /* Copy out the requested data */
208f76db8deSLandon J. Fuller memcpy(buffer, ptr, nbytes);
209f76db8deSLandon J. Fuller return (0);
210f76db8deSLandon J. Fuller }
211f76db8deSLandon J. Fuller
212f76db8deSLandon J. Fuller static int
bhnd_nvram_ioptr_write(struct bhnd_nvram_io * io,size_t offset,void * buffer,size_t nbytes)213f76db8deSLandon J. Fuller bhnd_nvram_ioptr_write(struct bhnd_nvram_io *io, size_t offset,
214f76db8deSLandon J. Fuller void *buffer, size_t nbytes)
215f76db8deSLandon J. Fuller {
216f76db8deSLandon J. Fuller void *ptr;
217f76db8deSLandon J. Fuller int error;
218f76db8deSLandon J. Fuller
219f76db8deSLandon J. Fuller /* Try to fetch a direct pointer for at least nbytes */
220f76db8deSLandon J. Fuller if ((error = bhnd_nvram_io_write_ptr(io, offset, &ptr, nbytes, NULL)))
221f76db8deSLandon J. Fuller return (error);
222f76db8deSLandon J. Fuller
223f76db8deSLandon J. Fuller /* Copy in the provided data */
224f76db8deSLandon J. Fuller memcpy(ptr, buffer, nbytes);
225f76db8deSLandon J. Fuller return (0);
226f76db8deSLandon J. Fuller }
227