1 /*
2  * Copyright (c) 2016, Freescale Semiconductor, Inc.
3  * Copyright 2017-2019 NXP
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  *
7  * Redistribution and use in source and binary forms, with or without modification,
8  * are permitted provided that the following conditions are met:
9  *
10  * o Redistributions of source code must retain the above copyright notice, this list
11  *   of conditions and the following disclaimer.
12  *
13  * o Redistributions in binary form must reproduce the above copyright notice, this
14  *   list of conditions and the following disclaimer in the documentation and/or
15  *   other materials provided with the distribution.
16  *
17  * o Neither the name of the copyright holder nor the names of its
18  *   contributors may be used to endorse or promote products derived from this
19  *   software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
25  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
28  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*!
34  * Header file for the MISC RPC implementation.
35  *
36  * @addtogroup MISC_SVC
37  * @{
38  */
39 
40 #ifndef SC_MISC_RPC_H
41 #define SC_MISC_RPC_H
42 
43 /* Includes */
44 
45 /* Defines */
46 
47 /*!
48  * @name Defines for RPC MISC function calls
49  */
50 /*@{*/
51 #define MISC_FUNC_UNKNOWN 0 /*!< Unknown function */
52 #define MISC_FUNC_SET_CONTROL 1U /*!< Index for sc_misc_set_control() RPC call */
53 #define MISC_FUNC_GET_CONTROL 2U /*!< Index for sc_misc_get_control() RPC call */
54 #define MISC_FUNC_SET_MAX_DMA_GROUP 4U /*!< Index for sc_misc_set_max_dma_group() RPC call */
55 #define MISC_FUNC_SET_DMA_GROUP 5U /*!< Index for sc_misc_set_dma_group() RPC call */
56 #define MISC_FUNC_DEBUG_OUT 10U /*!< Index for sc_misc_debug_out() RPC call */
57 #define MISC_FUNC_WAVEFORM_CAPTURE 6U /*!< Index for sc_misc_waveform_capture() RPC call */
58 #define MISC_FUNC_BUILD_INFO 15U /*!< Index for sc_misc_build_info() RPC call */
59 #define MISC_FUNC_API_VER 35U /*!< Index for sc_misc_api_ver() RPC call */
60 #define MISC_FUNC_UNIQUE_ID 19U /*!< Index for sc_misc_unique_id() RPC call */
61 #define MISC_FUNC_SET_ARI 3U /*!< Index for sc_misc_set_ari() RPC call */
62 #define MISC_FUNC_BOOT_STATUS 7U /*!< Index for sc_misc_boot_status() RPC call */
63 #define MISC_FUNC_BOOT_DONE 14U /*!< Index for sc_misc_boot_done() RPC call */
64 #define MISC_FUNC_OTP_FUSE_READ 11U /*!< Index for sc_misc_otp_fuse_read() RPC call */
65 #define MISC_FUNC_OTP_FUSE_WRITE 17U /*!< Index for sc_misc_otp_fuse_write() RPC call */
66 #define MISC_FUNC_SET_TEMP 12U /*!< Index for sc_misc_set_temp() RPC call */
67 #define MISC_FUNC_GET_TEMP 13U /*!< Index for sc_misc_get_temp() RPC call */
68 #define MISC_FUNC_GET_BOOT_DEV 16U /*!< Index for sc_misc_get_boot_dev() RPC call */
69 #define MISC_FUNC_GET_BOOT_TYPE 33U /*!< Index for sc_misc_get_boot_type() RPC call */
70 #define MISC_FUNC_GET_BOOT_CONTAINER 36U /*!< Index for sc_misc_get_boot_container() RPC call */
71 #define MISC_FUNC_GET_BUTTON_STATUS 18U /*!< Index for sc_misc_get_button_status() RPC call */
72 #define MISC_FUNC_ROMPATCH_CHECKSUM 26U /*!< Index for sc_misc_rompatch_checksum() RPC call */
73 #define MISC_FUNC_BOARD_IOCTL 34U /*!< Index for sc_misc_board_ioctl() RPC call */
74 /*@}*/
75 
76 /* Types */
77 
78 /* Functions */
79 
80 /*!
81  * This function dispatches an incoming MISC RPC request.
82  *
83  * @param[in]     caller_pt   caller partition
84  * @param[in]     mu          MU message came from
85  * @param[in]     msg         pointer to RPC message
86  */
87 void misc_dispatch(sc_rm_pt_t caller_pt, sc_rsrc_t mu, sc_rpc_msg_t *msg);
88 
89 #endif /* SC_MISC_RPC_H */
90 
91 /**@}*/
92 
93