soc: j721e: Add Devices info
[k3conf/k3conf.git] / include / tisci.h
1 /*
2  * TISCI helper apis header file
3  *
4  * Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/
5  *      Lokesh Vutla <lokeshvutla@ti.com>
6  *
7  *  Redistribution and use in source and binary forms, with or without
8  *  modification, are permitted provided that the following conditions
9  *  are met:
10  *
11  *    Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  *
14  *    Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the
17  *    distribution.
18  *
19  *    Neither the name of Texas Instruments Incorporated nor the names of
20  *    its contributors may be used to endorse or promote products derived
21  *    from this software without specific prior written permission.
22  *
23  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
36 #ifndef __TISCI_H
37 #define __TISCI_H
39 #include <stdint.h>
41 struct ti_sci_version_info {
42         uint8_t abi_major;
43         uint8_t abi_minor;
44         uint16_t firmware_version;
45         char firmware_description[32];
46 };
48 struct ti_sci_host_info {
49         uint32_t host_id;
50         char host_name[15];
51         char security_status[15];
52         char description[50];
53 };
55 #define MAIN_SEC_PROXY  0
56 #define MCU_SEC_PROXY   1
58 struct ti_sci_sec_proxy_info {
59         uint32_t sp_id;
60         char sp_dir[6];
61         uint32_t num_msgs;
62         char host[15];
63         char host_function[25];
64 };
66 struct ti_sci_processors_info {
67         uint32_t dev_id;
68         uint32_t clk_id;
69         uint32_t processor_id;
70         char name[20];
71 };
73 struct ti_sci_devices_info {
74         uint32_t dev_id;
75         char name[60];
76 };
78 struct ti_sci_info {
79         uint8_t host_id;
80         struct ti_sci_version_info version;
81         struct ti_sci_host_info *host_info;
82         uint32_t num_hosts;
83         struct ti_sci_sec_proxy_info *sp_info[2];
84         uint32_t num_sp_threads[2];
85         struct ti_sci_processors_info *processors_info;
86         uint32_t num_processors;
87         struct ti_sci_devices_info *devices_info;
88         uint32_t num_devices;
89 };
91 #define MAX_DEVICE_STATE_LENGTH         25
92 #define MAX_CLOCK_STATE_LENGTH          25
94 int ti_sci_init(void);
95 const char *ti_sci_cmd_get_device_status(uint32_t dev_id);
96 int ti_sci_cmd_disable_device(uint32_t dev_id);
97 int ti_sci_cmd_enable_device(uint32_t dev_id);
99 int ti_sci_cmd_get_clk(uint32_t dev_id, uint32_t clk_id);
100 int ti_sci_cmd_put_clk(uint32_t dev_id, uint32_t clk_id);
101 const char *ti_sci_cmd_get_clk_state(uint32_t dev_id, uint32_t clk_id);
102 int ti_sci_cmd_set_clk_freq(uint32_t dev_id, uint32_t clk_id, uint64_t freq);
103 int ti_sci_cmd_get_clk_freq(uint32_t dev_id, uint32_t clk_id, uint64_t *freq);
104 #endif