AM62x MCU+ SDK  09.02.01
tisci_pm_device.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017-2024 Texas Instruments Incorporated
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
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
53 #ifndef TISCI_PM_TISCI_DEVICE_H
54 #define TISCI_PM_TISCI_DEVICE_H
55 
56 #ifdef __cplusplus
57 extern "C"
58 {
59 #endif
60 
61 
62 
68 #define TISCI_MSG_FLAG_DEVICE_WAKE_ENABLED TISCI_BIT(8)
69 
71 #define TISCI_MSG_FLAG_DEVICE_RESET_ISO TISCI_BIT(9)
72 
80 #define TISCI_MSG_FLAG_DEVICE_EXCLUSIVE TISCI_BIT(10)
81 
87 #define TISCI_MSG_VALUE_DEVICE_SW_STATE_AUTO_OFF 0
88 
90 #define TISCI_MSG_VALUE_DEVICE_SW_STATE_RETENTION 1
91 
93 #define TISCI_MSG_VALUE_DEVICE_SW_STATE_ON 2
94 
99 #define TISCI_MSG_VALUE_DEVICE_HW_STATE_OFF 0
100 
105 #define TISCI_MSG_VALUE_DEVICE_HW_STATE_ON 1
106 
115 #define TISCI_MSG_VALUE_DEVICE_HW_STATE_TRANS 2
116 
136  struct tisci_header hdr;
137  uint32_t id;
138  uint32_t reserved;
139  uint8_t state;
140 } __attribute__((__packed__));
141 
151  struct tisci_header hdr;
152 } __attribute__((__packed__));
153 
163  struct tisci_header hdr;
164  uint32_t id;
165 } __attribute__((__packed__));
166 
187  struct tisci_header hdr;
189  uint32_t resets;
191  uint8_t current_state;
192 } __attribute__((__packed__));
193 
209  struct tisci_header hdr;
210  uint32_t id;
211  uint32_t resets;
212 } __attribute__((__packed__));
213 
223  struct tisci_header hdr;
224 } __attribute__((__packed__));
225 
240  struct tisci_header hdr;
241 } __attribute__((__packed__));
242 
252  struct tisci_header hdr;
253 } __attribute__((__packed__));
254 
255 
256 #ifdef __cplusplus
257 }
258 #endif
259 
260 #endif /* TISCI_PM_TISCI_DEVICE_H */
261 
tisci_msg_get_device_req::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:163
tisci_msg_set_device_resets_resp
Empty response for TISCI_MSG_SET_DEVICE_RESETS.
Definition: tisci_pm_device.h:222
tisci_msg_get_device_resp::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:187
tisci_msg_get_device_req
Request to get device based on id.
Definition: tisci_pm_device.h:162
tisci_msg_get_device_resp::context_loss_count
uint32_t context_loss_count
Definition: tisci_pm_device.h:188
tisci_msg_device_drop_powerup_ref_resp
Empty response for TISCI_MSG_DEVICE_DROP_POWERUP_REF.
Definition: tisci_pm_device.h:251
tisci_msg_set_device_req::state
uint8_t state
Definition: tisci_pm_device.h:139
tisci_msg_set_device_req::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:136
tisci_msg_set_device_resets_resp::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:223
tisci_header
Header that prefixes all TISCI messages.
Definition: tisci_protocol.h:94
tisci_msg_get_device_resp
Response to get device request.
Definition: tisci_pm_device.h:186
tisci_msg_set_device_resp
Empty response for TISCI_MSG_SET_DEVICE.
Definition: tisci_pm_device.h:150
tisci_msg_set_device_req
Set the desired state of the device.
Definition: tisci_pm_device.h:135
tisci_msg_device_drop_powerup_ref_resp::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:252
tisci_msg_device_drop_powerup_ref_req
Drop any remaining powerup device references.
Definition: tisci_pm_device.h:239
tisci_msg_set_device_req::reserved
uint32_t reserved
Definition: tisci_pm_device.h:138
tisci_msg_get_device_resp::programmed_state
uint8_t programmed_state
Definition: tisci_pm_device.h:190
tisci_msg_get_device_resp::current_state
uint8_t current_state
Definition: tisci_pm_device.h:191
tisci_msg_device_drop_powerup_ref_req::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:240
tisci_msg_set_device_resets_req::id
uint32_t id
Definition: tisci_pm_device.h:210
tisci_msg_set_device_resets_req::resets
uint32_t resets
Definition: tisci_pm_device.h:211
tisci_msg_set_device_resets_req::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:209
tisci_msg_set_device_req::id
uint32_t id
Definition: tisci_pm_device.h:137
tisci_msg_get_device_req::id
uint32_t id
Definition: tisci_pm_device.h:164
__attribute__
struct tisci_msg_set_device_req __attribute__((__packed__))
tisci_msg_get_device_resp::resets
uint32_t resets
Definition: tisci_pm_device.h:189
tisci_msg_set_device_resp::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:151
tisci_msg_set_device_resets_req
Set the desired state of the resets of a device.
Definition: tisci_pm_device.h:208