update hil_proc not to add new user data struct
[processor-sdk/open-amp.git] / lib / include / openamp / hil.h
1 #ifndef _HIL_H_
2 #define _HIL_H_
4 /*
5  * Copyright (c) 2014, Mentor Graphics Corporation
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice,
12  *    this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  *    this list of conditions and the following disclaimer in the documentation
15  *    and/or other materials provided with the distribution.
16  * 3. Neither the name of the <ORGANIZATION> nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
33 /**************************************************************************
34  * FILE NAME
35  *
36  *       hil.h
37  *
38  * DESCRIPTION
39  *
40  *       This file defines interface layer to access hardware features. This
41  *       interface is used by both RPMSG and remoteproc components.
42  *
43  ***************************************************************************/
45 #include "openamp/virtio.h"
46 #include "openamp/firmware.h"
47 #include "metal/list.h"
48 #include "metal/io.h"
49 #include "metal/device.h"
51 /* Configurable parameters */
52 #define HIL_MAX_CORES                   2
53 #define HIL_MAX_NUM_VRINGS              2
54 #define HIL_MAX_NUM_CHANNELS            1
55 /* Reserved CPU id */
56 #define HIL_RSVD_CPU_ID                 0xffffffff
58 /**
59  * struct proc_shm
60  *
61  * This structure is maintained by hardware interface layer for
62  * shared memory information. The shared memory provides buffers
63  * for use by the vring to exchange messages between the cores.
64  *
65  */
66 struct proc_shm {
67         /* Start address of shared memory used for buffers. */
68         void *start_addr;
69         /* Start physical address of shared memory used for buffers. */
70         metal_phys_addr_t start_paddr;
71         /* sharmed memory I/O region */
72         struct metal_io_region *io;
73         /* sharmed memory metal device */
74         struct metal_device *dev;
75         /* Size of shared memory. */
76         unsigned long size;
77         /* Attributes for shared memory - cached or uncached. */
78         unsigned long flags;
79 };
81 /**
82 * struct proc_intr
83 *
84 * This structure is maintained by hardware interface layer for
85 * notification(interrupts) mechanism. The most common notification mechanism
86 * is Inter-Processor Interrupt(IPI). There can be other mechanism depending
87 * on SoC architecture.
88 *
89 */
90 struct proc_intr {
91         /* Interrupt number for vring - use for IPI */
92         unsigned int vect_id;
93         /* Interrupt priority */
94         unsigned int priority;
95         /* Interrupt trigger type */
96         unsigned int trigger_type;
97         /* IPI metal device */
98         struct metal_device *dev;
99         /* IPI device I/O */
100         struct metal_io_region *io;
101         /* Private data */
102         void *data;
103 };
105 /**
106 * struct proc_vring
108 * This structure is maintained by hardware interface layer to keep
109 * vring physical memory and notification info.
111 */
112 struct proc_vring {
113         /* Pointer to virtqueue encapsulating the vring */
114         struct virtqueue *vq;
115         /* Vring logical address */
116         void *vaddr;
117         /* Vring metal device */
118         struct metal_device *dev;
119         /* Vring I/O region */
120         struct metal_io_region *io;
121         /* Number of vring descriptors */
122         unsigned short num_descs;
123         /* Vring alignment */
124         unsigned long align;
125         /* Vring interrupt control block */
126         struct proc_intr intr_info;
127 };
129 /**
130  * struct proc_vdev
131  *
132  * This structure represents a virtio HW device for remote processor.
133  * Currently only one virtio device per processor is supported.
134  *
135  */
136 struct proc_vdev {
137         /* Number of vrings */
138         unsigned int num_vrings;
139         /* Virtio device features */
140         unsigned int dfeatures;
141         /* Virtio gen features */
142         unsigned int gfeatures;
143         /* Vring info control blocks */
144         struct proc_vring vring_info[HIL_MAX_NUM_VRINGS];
145 };
147 /**
148  * struct proc_chnl
149  *
150  * This structure represents channel IDs that would be used by
151  * the remote in the name service message. This will be extended
152  * further to support static channel creation.
153  *
154  */
155 struct proc_chnl {
156         /* Channel ID */
157         char name[32];
158 };
160 /**
161 * struct hil_proc
163 * This structure represents a remote processor and encapsulates shared
164 * memory and notification info required for IPC.
166 */
167 struct hil_proc {
168         /* HIL CPU ID */
169         unsigned long cpu_id;
170         /* HIL platform ops table */
171         struct hil_platform_ops *ops;
172         /* Shared memory info */
173         struct proc_shm sh_buff;
174         /* Virtio device hardware info */
175         struct proc_vdev vdev;
176         /* Number of RPMSG channels */
177         unsigned long num_chnls;
178         /* RPMsg channels array */
179         struct proc_chnl chnls[HIL_MAX_NUM_CHANNELS];
180         /* Initialized status */
181         int is_initialized;
182         /* Attrbites to represent processor role, master or remote . This field is for
183          * future use. */
184         unsigned long attr;
185         /*
186          * CPU bitmask - shared variable updated by each core
187          * after it has been initialized. This field is for future use.
188          */
189         unsigned long cpu_bitmask;
190         /* Spin lock - This field is for future use. */
191         volatile unsigned int *slock;
192         /* private data */
193         void *pdata;
194         /* List node */
195         struct metal_list node;
196 };
198 /**
199  * hil_create_proc
200  *
201  * This function creates a HIL proc instance
202  *
203  * @param ops - hil proc platform operations
204  * @param cpu_id - remote CPU ID.
205  *                 E.g. the CPU ID of the remote processor in its
206  *                 cluster.
207  * @param pdata  - private data
208  * @return - pointer to proc instance
209  *
210  */
211 struct hil_proc *hil_create_proc(struct hil_platform_ops *ops,
212                                 unsigned long cpu_id, void *pdata);
214 /**
215  * hil_delete_proc
216  *
217  * This function deletes the given proc instance and frees the
218  * associated resources.
219  *
220  * @param proc - pointer to HIL proc instance
221  *
222  */
223 void hil_delete_proc(struct hil_proc *proc);
225 /**
226  * hil_init_proc
227  *
228  * This function initialize a HIL proc instance with the given platform data
229  * @param proc  - pointer to the hil_proc to initialize
230  *
231  * @return - 0 succeeded, non-0 for failure
232  *
233  */
234 int hil_init_proc(struct hil_proc *proc);
236 /**
237  * hil_isr()
238  *
239  * This function is called when interrupt is received for the vring.
240  * This function gets the corresponding virtqueue and generates
241  * call back for it.
242  *
243  * @param vring_hw   - pointer to vring control block
244  *
245  */
246 void hil_isr(struct proc_vring *vring_hw);
248 /**
249  * hil_get_vdev_info
250  *
251  * This function return virtio device for remote core.
252  *
253  * @param proc - pointer to remote proc
254  *
255  * @return - pointer to virtio HW device.
256  *
257  */
258 struct proc_vdev *hil_get_vdev_info(struct hil_proc *proc);
260 /**
261  * hil_get_chnl_info
262  *
263  * This function returns channels info for given proc.
264  *
265  * @param proc - pointer to proc info struct
266  * @param num_chnls - pointer to integer variable to hold
267  *                    number of available channels
268  *
269  * @return - pointer to channel info control block
270  *
271  */
272 struct proc_chnl *hil_get_chnl_info(struct hil_proc *proc, int *num_chnls);
274 /**
275  * hil_get_vring_info
276  *
277  * This function returns vring_info_table. The caller will use
278  * this table to get the vring HW info which will be subsequently
279  * used to create virtqueues.
280  *
281  * @param vdev - pointer to virtio HW device
282  * @param num_vrings - pointer to hold number of vrings
283  *
284  * @return - pointer to vring hardware info table
285  */
286 struct proc_vring *hil_get_vring_info(struct proc_vdev *vdev, int *num_vrings);
288 /**
289  * hil_get_shm_info
290  *
291  * This function returns shared memory info control block. The caller
292  * will use this information to create and manage memory buffers for
293  * vring descriptor table.
294  *
295  * @param proc - pointer to proc instance
296  *
297  * @return - pointer to shared memory region used for buffers
298  *
299  */
300 struct proc_shm *hil_get_shm_info(struct hil_proc *proc);
302 /**
303  * hil_enable_vring_notifications()
304  *
305  * This function is called after successful creation of virtqueues.
306  * This function saves queue handle in the vring_info_table which
307  * will be used during interrupt handling .This function setups
308  * interrupt handlers.
309  *
310  * @param vring_index - index to vring HW table
311  * @param vq          - pointer to virtqueue to save in vring HW table
312  *
313  * @return            - execution status
314  */
315 int hil_enable_vring_notifications(int vring_index, struct virtqueue *vq);
317 /**
318  * hil_vring_notify()
319  *
320  * This function generates IPI to let the other side know that there is
321  * job available for it. The required information to achieve this, like interrupt
322  * vector, CPU id etc is be obtained from the proc_vring table.
323  *
324  * @param vq - pointer to virtqueue
325  *
326  */
327 void hil_vring_notify(struct virtqueue *vq);
329 /**
330  * hil_get_status
331  *
332  * This function is used to check if the given core is up and running.
333  * This call will return after it is confirmed that remote core has
334  * started.
335  *
336  * @param proc - pointer to proc instance
337  *
338  * @return - execution status
339  */
340 int hil_get_status(struct hil_proc *proc);
342 /**
343  * hil_set_status
344  *
345  * This function is used to update the status
346  * of the given core i.e it is ready for IPC.
347  *
348  * @param proc - pointer to remote proc
349  *
350  * @return - execution status
351  */
353 int hil_set_status(struct hil_proc *proc);
355 /**
356  * hil_boot_cpu
357  *
358  * This function starts remote processor at given address.
359  *
360  * @param proc      - pointer to remote proc
361  * @param load_addr - load address of remote firmware
362  *
363  * @return - execution status
364  */
365 int hil_boot_cpu(struct hil_proc *proc, unsigned int load_addr);
367 /**
368  * hil_shutdown_cpu
369  *
370  *  This function shutdowns the remote processor
371  *
372  * @param proc - pointer to remote proc
373  *
374  */
375 void hil_shutdown_cpu(struct hil_proc *proc);
377 /**
378  * hil_get_firmware
379  *
380  * This function returns address and size of given firmware name passed as
381  * parameter.
382  *
383  * @param fw_name    - name of the firmware
384  * @param start_addr - pointer t hold start address of firmware
385  * @param size       - pointer to hold size of firmware
386  *
387  * returns -  status of function execution
388  *
389  */
390 int hil_get_firmware(char *fw_name, uintptr_t *start_addr,
391                      unsigned int *size);
393 /**
394  * hil_poll
395  *
396  * This function polls the remote processor.
397  * If it is blocking mode, it will not return until the remoteproc
398  * is signaled. If it is non-blocking mode, it will return 0
399  * if the remoteproc has pending signals, it will return non 0
400  * otherwise.
401  *
402  * @param proc     - hil_proc to poll
403  * @param nonblock - 0 for blocking, non-0 for non-blocking.
404  *
405  * @return - 0 for no errors, non-0 for errors.
406  */
407 int hil_poll (struct hil_proc *proc, int nonblock);
409 /**
410  * hil_set_shm
411  *
412  * This function set HIL proc shared memory
413  *
414  * @param proc     - hil_proc to set
415  * @param bus_name - bus name of the shared memory device
416  * @param name     - name of the shared memory, or platform device
417  *                   mandatory for Linux system.
418  * @param paddr    - physical address of the memory for baremetal/RTOS only
419  * @param size     - size of the shared memory
420  *
421  * If name argument exists, it will open the specified libmetal
422  * shared memory or the specified libmetal device if bus_name
423  * is specified to get the I/O region of the shared memory. Otherwise, it
424  * will use a generic normal I/O region for the shared memory.
425  * paddr argument is for baremetal/RTOS system only. Linux system
426  * will not take this paddr, for Linux system, you have to specify
427  * the name, otherwise, you will get segfault later.
428  *
429  * @return - 0 for no errors, non-0 for errors.
430  */
431 int hil_set_shm (struct hil_proc *proc,
432                  const char *bus_name, const char *name,
433                  metal_phys_addr_t paddr, size_t size);
435 /**
436  * hil_set_vring
437  *
438  * This function set HIL proc vring
439  *
440  * @param proc     - hil_proc to set
441  * @param index    - vring index
442  * @param bus_name - bus name of the vring device
443  * @param name     - name of the shared memory, or platform device
444  *                   mandatory for Linux system.
445  *
446  * If name argument exists, it will open the specified libmetal
447  * shared memory or the specified device if bus name is specified
448  * to get the I/O region of the vring.
449  *
450  * @return - 0 for no errors, non-0 for errors.
451  */
452 int hil_set_vring (struct hil_proc *proc, int index,
453                    const char *bus_name, const char *name);
455 /**
456  * hil_set_ipi
457  *
458  * This function set HIL proc IPI
459  *
460  * @param proc     - hil_proc to set
461  * @param index    - vring index for the IPI
462  * @param irq      - IPI irq vector ID
463  * @param data     - IPI data
464  *
465  * @return - 0 for no errors, non-0 for errors.
466  */
467 int hil_set_ipi (struct hil_proc *proc, int index,
468                  unsigned int irq, void *data);
470 /**
471  * hil_set_rpmsg_channel
472  *
473  * This function set HIL proc rpmsg_channel
474  *
475  * @param proc     - hil_proc to set
476  * @param index    - vring index for the rpmsg_channel
477  * @param name     - RPMsg channel name
478  *
479  * @return - 0 for no errors, non-0 for errors.
480  */
481 int hil_set_rpmsg_channel (struct hil_proc *proc, int index,
482                 char *name);
484 /**
485  *
486  * This structure is an interface between HIL and platform porting
487  * component. It is required for the user to provide definitions of
488  * these functions when framework is ported to new hardware platform.
489  *
490  */
491 struct hil_platform_ops {
492     /**
493      * enable_interrupt()
494      *
495      * This function enables interrupt(IPI) for given vring.
496      *
497      * @param vring_hw - pointer to vring control block
498      *
499      * @return  - execution status
500      */
501         int (*enable_interrupt) (struct proc_vring * vring_hw);
503     /**
504      * notify()
505      *
506      * This function generates IPI to let the other side know that there is
507      * job available for it.
508      *
509      * @param proc - pointer to the hil_proc
510      * @param intr_info - pointer to interrupt info control block
511      */
512         void (*notify) (struct hil_proc *proc, struct proc_intr * intr_info);
514     /**
515      * boot_cpu
516      *
517      * This unction boots the remote processor.
518      *
519      * @param proc - pointer to the hil_proc
520      * @param start_addr - start address of remote cpu
521      *
522      * @return - execution status
523      */
524         int (*boot_cpu) (struct hil_proc *proc, unsigned int start_addr);
526     /**
527      * shutdown_cpu
528      *
529      *  This function shutdowns the remote processor.
530      *
531      * @param proc - pointer to the hil_proc
532      *
533      */
534         void (*shutdown_cpu) (struct hil_proc *proc);
536     /**
537      * poll
538      *
539      * This function polls the remote processor.
540      *
541      * @param proc     - hil_proc to poll
542      * @param nonblock - 0 for blocking, non-0 for non-blocking.
543      *
544      * @return - 0 for no errors, non-0 for errors.
545      */
546         int (*poll) (struct hil_proc *proc, int nonblock);
548     /**
549      * initialize
550      *
551      *  This function initialize remote processor with platform data.
552      *
553      * @param proc     - hil_proc to poll
554      *
555      * @return NULL on failure, hil_proc pointer otherwise
556      *
557      */
558         int (*initialize) (struct hil_proc *proc);
560     /**
561      * release
562      *
563      *  This function is to release remote processor resource
564      *
565      * @param[in] proc - pointer to the remote processor
566      *
567      */
568         void (*release) (struct hil_proc *proc);
569 };
571 /* Utility macros for register read/write */
572 #define         HIL_MEM_READ8(addr)         *(volatile unsigned char *)(addr)
573 #define         HIL_MEM_READ16(addr)        *(volatile unsigned short *)(addr)
574 #define         HIL_MEM_READ32(addr)        *(volatile unsigned long *)(addr)
575 #define         HIL_MEM_WRITE8(addr,data)   *(volatile unsigned char *)(addr) = (unsigned char)(data)
576 #define         HIL_MEM_WRITE16(addr,data)  *(volatile unsigned short *)(addr) = (unsigned short)(data)
577 #define         HIL_MEM_WRITE32(addr,data)  *(volatile unsigned long *)(addr) = (unsigned long)(data)
579 #endif                          /* _HIL_H_ */