examples: Add rpmsg_char_simple example
[rpmsg/ti-rpmsg-char.git] / include / rproc_id.h
1 /*
2  * Copyright (c) 2020 Texas Instruments Incorporated - https://www.ti.com
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  *    Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  *    Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  *    Neither the name of Texas Instruments Incorporated nor the names of
16  *    its contributors may be used to endorse or promote products derived
17  *    from this software without specific prior written permission.
18  *
19  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  *
31  */
33 #ifndef __RPROC_ID_H__
34 #define __RPROC_ID_H__
36 #if defined(__cplusplus)
37 extern "C" {
38 #endif
40 /*!
41  * @brief Enum values identifying a remote processor uniquely across
42  *        all SoCs
43  *
44  *        The enum defines a unique remoteproc id and is limited by
45  *        RPROC_ID_MAX value, and is agnostic of the SoC family.
46  *
47  *        NOTE:
48  *        1. These enum values are to be used as identifiers only.
49  *           Do not assume a specific value associated with a particular
50  *           value.
51  *        2. The RPROC_ID_MAX again is subject to change as new remoteprocs
52  *           are added.
53  *
54  *        Any new remote processor will need to have an id added to
55  *        this enum.
56  */
57 enum rproc_id {
58         R5F_MCU0_0 = 0,
59         R5F_MCU0_1,
60         R5F_MAIN0_0,
61         R5F_MAIN0_1,
62         R5F_MAIN1_0,
63         R5F_MAIN1_1,
64         DSP_C66_0,
65         DSP_C66_1,
66         DSP_C71_0,
67         RPROC_ID_MAX,
68 };
70 #if defined(__cplusplus)
71 }
72 #endif
74 #endif /* __RPROC_ID_H__ */