mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-12 13:55:32 +00:00
![Luis Chamberlain](/assets/img/avatar_default.png)
Formalize the built-in firmware with a proper API. This can later be used by other callers where all they need is built-in firmware. We export the firmware_request_builtin() call for now only under the TEST_FIRMWARE symbol namespace as there are no direct modular users for it. If they pop up they are free to export it generally. Built-in code always gets access to the callers and we'll demonstrate a hidden user which has been lurking in the kernel for a while and the reason why using a proper API was better long term. Reviewed-by: Borislav Petkov <bp@suse.de> Signed-off-by: Luis Chamberlain <mcgrof@kernel.org> Link: https://lore.kernel.org/r/20211021155843.1969401-2-mcgrof@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
136 lines
3.6 KiB
C
136 lines
3.6 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _LINUX_FIRMWARE_H
|
|
#define _LINUX_FIRMWARE_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/compiler.h>
|
|
#include <linux/gfp.h>
|
|
|
|
#define FW_ACTION_NOUEVENT 0
|
|
#define FW_ACTION_UEVENT 1
|
|
|
|
struct firmware {
|
|
size_t size;
|
|
const u8 *data;
|
|
|
|
/* firmware loader private fields */
|
|
void *priv;
|
|
};
|
|
|
|
struct module;
|
|
struct device;
|
|
|
|
/*
|
|
* Built-in firmware functionality is only available if FW_LOADER=y, but not
|
|
* FW_LOADER=m
|
|
*/
|
|
#ifdef CONFIG_FW_LOADER
|
|
struct builtin_fw {
|
|
char *name;
|
|
void *data;
|
|
unsigned long size;
|
|
};
|
|
|
|
bool firmware_request_builtin(struct firmware *fw, const char *name);
|
|
|
|
/* We have to play tricks here much like stringify() to get the
|
|
__COUNTER__ macro to be expanded as we want it */
|
|
#define __fw_concat1(x, y) x##y
|
|
#define __fw_concat(x, y) __fw_concat1(x, y)
|
|
|
|
#define DECLARE_BUILTIN_FIRMWARE(name, blob) \
|
|
DECLARE_BUILTIN_FIRMWARE_SIZE(name, &(blob), sizeof(blob))
|
|
|
|
#define DECLARE_BUILTIN_FIRMWARE_SIZE(name, blob, size) \
|
|
static const struct builtin_fw __fw_concat(__builtin_fw,__COUNTER__) \
|
|
__used __section(".builtin_fw") = { name, blob, size }
|
|
|
|
#else
|
|
static inline bool firmware_request_builtin(struct firmware *fw,
|
|
const char *name)
|
|
{
|
|
return false;
|
|
}
|
|
#endif
|
|
|
|
#if defined(CONFIG_FW_LOADER) || (defined(CONFIG_FW_LOADER_MODULE) && defined(MODULE))
|
|
int request_firmware(const struct firmware **fw, const char *name,
|
|
struct device *device);
|
|
int firmware_request_nowarn(const struct firmware **fw, const char *name,
|
|
struct device *device);
|
|
int firmware_request_platform(const struct firmware **fw, const char *name,
|
|
struct device *device);
|
|
int request_firmware_nowait(
|
|
struct module *module, bool uevent,
|
|
const char *name, struct device *device, gfp_t gfp, void *context,
|
|
void (*cont)(const struct firmware *fw, void *context));
|
|
int request_firmware_direct(const struct firmware **fw, const char *name,
|
|
struct device *device);
|
|
int request_firmware_into_buf(const struct firmware **firmware_p,
|
|
const char *name, struct device *device, void *buf, size_t size);
|
|
int request_partial_firmware_into_buf(const struct firmware **firmware_p,
|
|
const char *name, struct device *device,
|
|
void *buf, size_t size, size_t offset);
|
|
|
|
void release_firmware(const struct firmware *fw);
|
|
#else
|
|
static inline int request_firmware(const struct firmware **fw,
|
|
const char *name,
|
|
struct device *device)
|
|
{
|
|
return -EINVAL;
|
|
}
|
|
|
|
static inline int firmware_request_nowarn(const struct firmware **fw,
|
|
const char *name,
|
|
struct device *device)
|
|
{
|
|
return -EINVAL;
|
|
}
|
|
|
|
static inline int firmware_request_platform(const struct firmware **fw,
|
|
const char *name,
|
|
struct device *device)
|
|
{
|
|
return -EINVAL;
|
|
}
|
|
|
|
static inline int request_firmware_nowait(
|
|
struct module *module, bool uevent,
|
|
const char *name, struct device *device, gfp_t gfp, void *context,
|
|
void (*cont)(const struct firmware *fw, void *context))
|
|
{
|
|
return -EINVAL;
|
|
}
|
|
|
|
static inline void release_firmware(const struct firmware *fw)
|
|
{
|
|
}
|
|
|
|
static inline int request_firmware_direct(const struct firmware **fw,
|
|
const char *name,
|
|
struct device *device)
|
|
{
|
|
return -EINVAL;
|
|
}
|
|
|
|
static inline int request_firmware_into_buf(const struct firmware **firmware_p,
|
|
const char *name, struct device *device, void *buf, size_t size)
|
|
{
|
|
return -EINVAL;
|
|
}
|
|
|
|
static inline int request_partial_firmware_into_buf
|
|
(const struct firmware **firmware_p,
|
|
const char *name,
|
|
struct device *device,
|
|
void *buf, size_t size, size_t offset)
|
|
{
|
|
return -EINVAL;
|
|
}
|
|
|
|
#endif
|
|
|
|
int firmware_request_cache(struct device *device, const char *name);
|
|
|
|
#endif
|