Use lib/ for source files for OpenAMP library
[processor-sdk/open-amp.git] / lib / include / openamp / rsc_table_parser.h
1 /*
2  * Copyright (c) 2014, Mentor Graphics Corporation
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  *    this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  *    this list of conditions and the following disclaimer in the documentation
12  *    and/or other materials provided with the distribution.
13  * 3. Neither the name of Mentor Graphics Corporation nor the names of its
14  *    contributors may be used to endorse or promote products derived from this
15  *    software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
30 #ifndef RSC_TABLE_PARSER_H
31 #define RSC_TABLE_PARSER_H
33 #include "openamp/remoteproc.h"
34 #include "openamp/env.h"
35 #include "openamp/hil.h"
37 #define RSC_TAB_SUPPORTED_VERSION           1
38 #define RSC_TAB_HEADER_SIZE                 12
39 #define RSC_TAB_MAX_VRINGS                  2
41 /* Standard control request handling. */
42 typedef int (*rsc_handler) (struct remote_proc * rproc, void *rsc);
44 /* Function prototypes */
45 int handle_rsc_table(struct remote_proc *rproc,
46                      struct resource_table *rsc_table, int len);
47 int handle_carve_out_rsc(struct remote_proc *rproc, void *rsc);
48 int handle_trace_rsc(struct remote_proc *rproc, void *rsc);
49 int handle_dev_mem_rsc(struct remote_proc *rproc, void *rsc);
50 int handle_vdev_rsc(struct remote_proc *rproc, void *rsc);
51 int handle_mmu_rsc(struct remote_proc *rproc, void *rsc);
53 #endif                          /* RSC_TABLE_PARSER_H */