blob: 49871949055a220eb924f96df2593827e003d3f5 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Nishanth Menonddf56bc2015-09-17 15:42:39 -05002/*
3 * (C) Copyright 2015
4 * Texas Instruments Incorporated - http://www.ti.com/
Nishanth Menonddf56bc2015-09-17 15:42:39 -05005 */
6
7#ifndef _RPROC_H_
8#define _RPROC_H_
9
10/*
11 * Note: The platform data support is not meant for use with newer
12 * platforms. This is meant only for legacy devices. This mode of
13 * initialization *will* be eventually removed once all necessary
14 * platforms have moved to dm/fdt.
15 */
16#include <dm/platdata.h> /* For platform data support - non dt world */
17
18/**
19 * enum rproc_mem_type - What type of memory model does the rproc use
20 * @RPROC_INTERNAL_MEMORY_MAPPED: Remote processor uses own memory and is memory
21 * mapped to the host processor over an address range.
22 *
23 * Please note that this is an enumeration of memory model of different types
24 * of remote processors. Few of the remote processors do have own internal
25 * memories, while others use external memory for instruction and data.
26 */
27enum rproc_mem_type {
28 RPROC_INTERNAL_MEMORY_MAPPED = 0,
29};
30
31/**
32 * struct dm_rproc_uclass_pdata - platform data for a CPU
33 * @name: Platform-specific way of naming the Remote proc
34 * @mem_type: one of 'enum rproc_mem_type'
35 * @driver_plat_data: driver specific platform data that may be needed.
36 *
37 * This can be accessed with dev_get_uclass_platdata() for any UCLASS_REMOTEPROC
38 * device.
39 *
40 */
41struct dm_rproc_uclass_pdata {
42 const char *name;
43 enum rproc_mem_type mem_type;
44 void *driver_plat_data;
45};
46
47/**
Fabien Dessenne31a839f2019-05-31 15:11:31 +020048 * struct dm_rproc_ops - Driver model remote proc operations.
49 *
50 * This defines the operations provided by remote proc driver.
Nishanth Menonddf56bc2015-09-17 15:42:39 -050051 */
52struct dm_rproc_ops {
Fabien Dessenne31a839f2019-05-31 15:11:31 +020053 /**
54 * init() - Initialize the remoteproc device (optional)
55 *
56 * This is called after the probe is completed allowing the remote
57 * processor drivers to split up the initializations between probe and
58 * init if needed.
59 *
60 * @dev: Remote proc device
61 * @return 0 if all ok, else appropriate error value.
62 */
Nishanth Menonddf56bc2015-09-17 15:42:39 -050063 int (*init)(struct udevice *dev);
Fabien Dessenne31a839f2019-05-31 15:11:31 +020064
65 /**
66 * load() - Load the remoteproc device using data provided (mandatory)
67 *
68 * Load the remoteproc device with an image, do not start the device.
69 *
70 * @dev: Remote proc device
71 * @addr: Address of the image to be loaded
72 * @size: Size of the image to be loaded
73 * @return 0 if all ok, else appropriate error value.
74 */
Nishanth Menonddf56bc2015-09-17 15:42:39 -050075 int (*load)(struct udevice *dev, ulong addr, ulong size);
Fabien Dessenne31a839f2019-05-31 15:11:31 +020076
77 /**
78 * start() - Start the remoteproc device (mandatory)
79 *
80 * @dev: Remote proc device
81 * @return 0 if all ok, else appropriate error value.
82 */
Nishanth Menonddf56bc2015-09-17 15:42:39 -050083 int (*start)(struct udevice *dev);
Fabien Dessenne31a839f2019-05-31 15:11:31 +020084
85 /**
86 * stop() - Stop the remoteproc device (optional)
87 *
88 * @dev: Remote proc device
89 * @return 0 if all ok, else appropriate error value.
90 */
Nishanth Menonddf56bc2015-09-17 15:42:39 -050091 int (*stop)(struct udevice *dev);
Fabien Dessenne31a839f2019-05-31 15:11:31 +020092
93 /**
94 * reset() - Reset the remoteproc device (optional)
95 *
96 * @dev: Remote proc device
97 * @return 0 if all ok, else appropriate error value.
98 */
Nishanth Menonddf56bc2015-09-17 15:42:39 -050099 int (*reset)(struct udevice *dev);
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200100
101 /**
102 * is_running() - Check if the remote processor is running (optional)
103 *
104 * @dev: Remote proc device
105 * @return 0 if running, 1 if not running, -ve on error.
106 */
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500107 int (*is_running)(struct udevice *dev);
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200108
109 /**
110 * ping() - Ping the remote device for basic communication (optional)
111 *
112 * @dev: Remote proc device
113 * @return 0 on success, 1 if not responding, -ve on other errors.
114 */
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500115 int (*ping)(struct udevice *dev);
Fabien Dessenne163b7d72019-05-31 15:11:32 +0200116
117 /**
118 * device_to_virt() - Return translated virtual address (optional)
119 *
120 * Translate a device address (remote processor view) to virtual
121 * address (main processor view).
122 *
123 * @dev: Remote proc device
124 * @da: Device address
125 * @return virtual address.
126 */
127 void * (*device_to_virt)(struct udevice *dev, ulong da);
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500128};
129
130/* Accessor */
131#define rproc_get_ops(dev) ((struct dm_rproc_ops *)(dev)->driver->ops)
132
Suman Anna26557d12019-07-19 10:27:56 -0500133#if CONFIG_IS_ENABLED(REMOTEPROC)
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500134/**
135 * rproc_init() - Initialize all bound remote proc devices
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200136 * @return 0 if all ok, else appropriate error value.
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500137 */
138int rproc_init(void);
139
140/**
Lokesh Vutla81ae6e62018-08-27 15:57:50 +0530141 * rproc_dev_init() - Initialize a remote proc device based on id
142 * @id: id of the remote processor
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200143 * @return 0 if all ok, else appropriate error value.
Lokesh Vutla81ae6e62018-08-27 15:57:50 +0530144 */
145int rproc_dev_init(int id);
146
147/**
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500148 * rproc_is_initialized() - check to see if remoteproc devices are initialized
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200149 * @return true if all devices are initialized, false otherwise.
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500150 */
151bool rproc_is_initialized(void);
152
153/**
Fabien Dessenne7a7c4cb2019-05-31 15:11:33 +0200154 * rproc_load() - load binary or elf to a remote processor
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500155 * @id: id of the remote processor
Fabien Dessenne7a7c4cb2019-05-31 15:11:33 +0200156 * @addr: address in memory where the image is located
157 * @size: size of the image
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200158 * @return 0 if all ok, else appropriate error value.
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500159 */
160int rproc_load(int id, ulong addr, ulong size);
161
162/**
163 * rproc_start() - Start a remote processor
164 * @id: id of the remote processor
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200165 * @return 0 if all ok, else appropriate error value.
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500166 */
167int rproc_start(int id);
168
169/**
170 * rproc_stop() - Stop a remote processor
171 * @id: id of the remote processor
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200172 * @return 0 if all ok, else appropriate error value.
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500173 */
174int rproc_stop(int id);
175
176/**
177 * rproc_reset() - reset a remote processor
178 * @id: id of the remote processor
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200179 * @return 0 if all ok, else appropriate error value.
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500180 */
181int rproc_reset(int id);
182
183/**
184 * rproc_ping() - ping a remote processor to check if it can communicate
185 * @id: id of the remote processor
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200186 * @return 0 if all ok, else appropriate error value.
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500187 *
188 * NOTE: this might need communication path available, which is not implemented
189 * as part of remoteproc framework - hook on to appropriate bus architecture to
190 * do the same
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500191 */
192int rproc_ping(int id);
193
194/**
195 * rproc_is_running() - check to see if remote processor is running
196 * @id: id of the remote processor
Fabien Dessenne31a839f2019-05-31 15:11:31 +0200197 * @return 0 if running, 1 if not running, -ve on error.
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500198 *
199 * NOTE: this may not involve actual communication capability of the remote
200 * processor, but just ensures that it is out of reset and executing code.
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500201 */
202int rproc_is_running(int id);
Fabien Dessenne7a7c4cb2019-05-31 15:11:33 +0200203
204/**
205 * rproc_elf32_sanity_check() - Verify if an image is a valid ELF32 one
206 *
207 * Check if a valid ELF32 image exists at the given memory location. Verify
208 * basic ELF32 format requirements like magic number and sections size.
209 *
210 * @addr: address of the image to verify
211 * @size: size of the image
212 * @return 0 if the image looks good, else appropriate error value.
213 */
214int rproc_elf32_sanity_check(ulong addr, ulong size);
215
216/**
217 * rproc_elf32_load_image() - load an ELF32 image
218 * @dev: device loading the ELF32 image
219 * @addr: valid ELF32 image address
220 * @return 0 if the image is successfully loaded, else appropriate error value.
221 */
222int rproc_elf32_load_image(struct udevice *dev, unsigned long addr);
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500223#else
224static inline int rproc_init(void) { return -ENOSYS; }
Lokesh Vutla81ae6e62018-08-27 15:57:50 +0530225static inline int rproc_dev_init(int id) { return -ENOSYS; }
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500226static inline bool rproc_is_initialized(void) { return false; }
227static inline int rproc_load(int id, ulong addr, ulong size) { return -ENOSYS; }
228static inline int rproc_start(int id) { return -ENOSYS; }
229static inline int rproc_stop(int id) { return -ENOSYS; }
230static inline int rproc_reset(int id) { return -ENOSYS; }
231static inline int rproc_ping(int id) { return -ENOSYS; }
232static inline int rproc_is_running(int id) { return -ENOSYS; }
Fabien Dessenne7a7c4cb2019-05-31 15:11:33 +0200233static inline int rproc_elf32_sanity_check(ulong addr,
234 ulong size) { return -ENOSYS; }
235static inline int rproc_elf32_load_image(struct udevice *dev,
236 unsigned long addr) { return -ENOSYS; }
Nishanth Menonddf56bc2015-09-17 15:42:39 -0500237#endif
238
239#endif /* _RPROC_H_ */