firmware.h revision 154974 
1/*-
2 * Copyright (c) 2005, Sam Leffler <sam@errno.com>
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 unmodified, this list of conditions, and the following
10 *    disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/sys/firmware.h 154974 2006-01-29 02:52:42Z mlaier $
27 */
28#ifndef _SYS_FIRMWARE_H_
29#define _SYS_FIRMWARE_H_
30/*
31 * Loadable firmware support.
32 *
33 * Firmware images are embedded in kernel loadable modules that can
34 * be loaded on-demand or pre-loaded as desired.  Modules may contain
35 * one or more firmware images that are stored as opaque data arrays
36 * and registered with a unique string name.  Consumers request
37 * firmware by name with held references counted to use in disallowing
38 * module/data unload.
39 *
40 * When multiple images are stored in one module the one image is
41 * treated as the master with the other images holding references
42 * to it.  This means that to unload the module each dependent/subimage
43 * must first have its references removed.
44 */
45struct firmware {
46	const char	*name;		/* system-wide name */
47	const void	*data;		/* location of image */
48	size_t		 datasize;	/* size of image in bytes */
49	unsigned int	 version;	/* version of the image */
50	int		 refcnt;	/* held references */
51	struct firmware *parent;	/* not null if a subimage */
52	linker_file_t	 file;		/* loadable module */
53};
54
55struct firmware	*firmware_register(const char *, const void *, size_t,
56    unsigned int, struct firmware *);
57int		 firmware_unregister(const char *);
58struct firmware *firmware_get(const char *);
59#define	FIRMWARE_UNLOAD		0x0001	/* unload if unreferenced */
60void		 firmware_put(struct firmware *, int);
61#endif /* _SYS_FIRMWARE_H_ */
62