blob: 12b0995c8087f395451e2284e4c1d6a7e78ec03c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
/* SPDX-License-Identifier: GPL-2.0 */
/*
* GXP MicroController Unit firmware management.
*
* Copyright (C) 2022 Google LLC
*/
#ifndef __GXP_MCU_FIRMWARE_H__
#define __GXP_MCU_FIRMWARE_H__
#include <linux/mutex.h>
#include <gcip/gcip-firmware.h>
#include <gcip/gcip-image-config.h>
#include "gxp-internal.h"
struct gxp_mcu_firmware {
struct gxp_dev *gxp;
/* resource for MCU firmware image */
struct gxp_mapped_resource image_buf;
struct mutex lock; /* lock to protect fields below */
enum gcip_fw_status status;
struct gcip_fw_info fw_info;
struct gcip_image_config_parser cfg_parser;
const char *name; /* the firmware name last loaded */
bool is_signed;
};
/*
* Initializes @mcu_fw.
*
* Returns 0 on success, a negative errno on failure.
*/
int gxp_mcu_firmware_init(struct gxp_dev *gxp, struct gxp_mcu_firmware *mcu_fw);
/* cleans up resources in @mcu_fw */
void gxp_mcu_firmware_exit(struct gxp_mcu_firmware *mcu_fw);
/*
* Loads and runs the MCU firmware. The firmware is ready to serve when this
* call succeeds.
*
* Returns 0 on success, a negative errno on failure.
*/
int gxp_mcu_firmware_run(struct gxp_mcu_firmware *mcu_fw);
/*
* Stops the running MCU firmware.
*/
void gxp_mcu_firmware_stop(struct gxp_mcu_firmware *mcu_fw);
/*
* Returns the pointer of MCU firmware associated with the GXP device object.
*
* This function is NOT implemented in gxp-mcu-firmware.c. Instead, it shall be
* implemented in *-platform.c as a chip-dependent implementation.
*
* It's okay to not implement this function for chips without MCU support,
* because in this case this function will never be used.
*/
struct gxp_mcu_firmware *gxp_mcu_firmware_of(struct gxp_dev *gxp);
/*
* Handles the MCU firmware crash. It will handle the crash only when the @crash_type is
* GCIP_FW_CRASH_UNRECOVERABLE_FAULT. Otherwise, it will ignore that crash.
*
* This function will be called from the `gxp-kci.c` when GCIP_RKCI_FIRMWARE_CRASH RKCI is arrived
* from the MCU firmware side.
*/
void gxp_mcu_firmware_crash_handler(struct gxp_dev *gxp,
enum gcip_fw_crash_type crash_type);
#endif /* __GXP_MCU_FIRMWARE_H__ */
|
