| 1 | /*- |
| 2 | * SPDX-License-Identifier: BSD-2-Clause |
| 3 | * |
| 4 | * Copyright (c) 2005, Sam Leffler <sam@errno.com> |
| 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 unmodified, this list of conditions, and the following |
| 12 | * disclaimer. |
| 13 | * 2. Redistributions in binary form must reproduce the above copyright |
| 14 | * notice, this list of conditions and the following disclaimer in the |
| 15 | * documentation and/or other materials provided with the distribution. |
| 16 | * |
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 27 | */ |
| 28 | #ifndef _SYS_FIRMWARE_H_ |
| 29 | #define _SYS_FIRMWARE_H_ |
| 30 | /* |
| 31 | * Loadable firmware support. |
| 32 | * |
| 33 | * The firmware abstraction provides an interface for loading firmware |
| 34 | * images into the kernel and making them available to clients. |
| 35 | * |
| 36 | * Firmware images are usually embedded in kernel loadable modules that can |
| 37 | * be loaded on-demand or pre-loaded as desired. Modules may contain |
| 38 | * one or more firmware images that are stored as opaque data arrays |
| 39 | * and registered with a unique string name. Clients request |
| 40 | * firmware by name, and are returned a struct firmware * below on success. |
| 41 | * The kernel keeps track of references to firmware images to allow/prevent |
| 42 | * module/data unload. |
| 43 | * |
| 44 | * When multiple images are stored in one module, the first image is |
| 45 | * treated as the master with the other images holding references |
| 46 | * to it. This means that to unload the module each dependent/subimage |
| 47 | * must first have its references removed. |
| 48 | * In order for automatic loading to work, the master image must have |
| 49 | * the same name as the module it is embedded into. |
| 50 | */ |
| 51 | struct firmware { |
| 52 | const char *name; /* system-wide name */ |
| 53 | const void *data; /* location of image */ |
| 54 | size_t datasize; /* size of image in bytes */ |
| 55 | unsigned int version; /* version of the image */ |
| 56 | }; |
| 57 | |
| 58 | const struct firmware *firmware_register(const char *, |
| 59 | const void *, size_t, unsigned int, const struct firmware *); |
| 60 | int firmware_unregister(const char *); |
| 61 | |
| 62 | #define FIRMWARE_GET_NOWARN 0x0001 /* Do not warn if firmware not found. */ |
| 63 | const struct firmware *firmware_get_flags(const char *, uint32_t flags); |
| 64 | const struct firmware *firmware_get(const char *); |
| 65 | |
| 66 | #define FIRMWARE_UNLOAD 0x0001 /* unload if unreferenced */ |
| 67 | void firmware_put(const struct firmware *, int); |
| 68 | |
| 69 | #endif /* _SYS_FIRMWARE_H_ */ |