xref: /freebsd/sys/sys/slicer.h (revision 0957b409)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2012 Semihalf.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _FLASH_SLICER_H_
32 #define	_FLASH_SLICER_H_
33 
34 #include <sys/types.h>
35 
36 #define	FLASH_SLICES_MAX_NUM		8
37 #define	FLASH_SLICES_MAX_NAME_LEN	(32 + 1)
38 
39 #define	FLASH_SLICES_FLAG_NONE		0
40 #define	FLASH_SLICES_FLAG_RO		1	/* Read only */
41 
42 #define	FLASH_SLICES_FMT		"%ss.%s"
43 
44 struct flash_slice {
45 	off_t		base;
46 	off_t		size;
47 	const char	*label;
48 	unsigned int	flags;
49 };
50 
51 #ifdef _KERNEL
52 
53 typedef int (*flash_slicer_t)(device_t dev, const char *provider,
54     struct flash_slice *slices, int *slices_num);
55 
56 #define	FLASH_SLICES_TYPE_NAND		0
57 #define	FLASH_SLICES_TYPE_CFI		1
58 #define	FLASH_SLICES_TYPE_SPI		2
59 #define	FLASH_SLICES_TYPE_MMC		3
60 
61 /* Use NULL for deregistering a slicer */
62 void flash_register_slicer(flash_slicer_t slicer, u_int type, bool force);
63 
64 #endif /* _KERNEL */
65 
66 #endif /* _FLASH_SLICER_H_ */
67