1/*-
2 * Copyright (c) 2015-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	_MIPS_BROADCOM_BCM_NVRAM_CFE_H_
33#define	_MIPS_BROADCOM_BCM_NVRAM_CFE_H_
34
35#include <sys/param.h>
36#include <sys/bus.h>
37
38#include <dev/bhnd/nvram/bhnd_nvram.h>
39#include <dev/bhnd/nvram/bhnd_nvram_iovar.h>
40#include <dev/bhnd/nvram/bhnd_nvram_store.h>
41
42struct bcm_nvram_iocfe;
43
44int		bcm_nvram_find_cfedev(struct bcm_nvram_iocfe *iocfe,
45		    bhnd_nvram_data_class **cls);
46
47/**
48 * CFE-backed bhnd_nvram_io implementation.
49 */
50struct bcm_nvram_iocfe {
51	struct bhnd_nvram_io	 io;		/**< common I/O instance state */
52
53	char			*dname;		/**< CFE device name (borrowed) */
54	int			 fd;		/**< CFE file descriptor */
55	size_t			 offset;	/**< base offset */
56	size_t			 size;		/**< device size */
57	bool			 req_blk_erase;	/**< flash blocks must be erased
58						     before writing */
59};
60
61/** bhnd_nvram_cfe driver instance state. */
62struct bhnd_nvram_cfe_softc {
63	device_t		 	 dev;
64	struct bhnd_nvram_store		*store;	/**< nvram store */
65};
66
67#endif /* _MIPS_BROADCOM_BCM_NVRAM_CFE_H_ */
68