AM64x MCU+ SDK  08.00.00
tisci_pm_device.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017-2021 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 
62 #define TISCI_MSG_FLAG_DEVICE_WAKE_ENABLED TISCI_BIT(8)
63 
65 #define TISCI_MSG_FLAG_DEVICE_RESET_ISO TISCI_BIT(9)
66 
74 #define TISCI_MSG_FLAG_DEVICE_EXCLUSIVE TISCI_BIT(10)
75 
81 #define TISCI_MSG_VALUE_DEVICE_SW_STATE_AUTO_OFF 0
82 
84 #define TISCI_MSG_VALUE_DEVICE_SW_STATE_RETENTION 1
85 
87 #define TISCI_MSG_VALUE_DEVICE_SW_STATE_ON 2
88 
93 #define TISCI_MSG_VALUE_DEVICE_HW_STATE_OFF 0
94 
99 #define TISCI_MSG_VALUE_DEVICE_HW_STATE_ON 1
100 
109 #define TISCI_MSG_VALUE_DEVICE_HW_STATE_TRANS 2
110 
130  struct tisci_header hdr;
131  uint32_t id;
132  uint32_t reserved;
133  uint8_t state;
134 } __attribute__((__packed__));
135 
145  struct tisci_header hdr;
146 } __attribute__((__packed__));
147 
157  struct tisci_header hdr;
158  uint32_t id;
159 } __attribute__((__packed__));
160 
181  struct tisci_header hdr;
183  uint32_t resets;
185  uint8_t current_state;
186 } __attribute__((__packed__));
187 
203  struct tisci_header hdr;
204  uint32_t id;
205  uint32_t resets;
206 } __attribute__((__packed__));
207 
217  struct tisci_header hdr;
218 } __attribute__((__packed__));
219 
234  struct tisci_header hdr;
235 } __attribute__((__packed__));
236 
246  struct tisci_header hdr;
247 } __attribute__((__packed__));
248 
249 #endif /* TISCI_PM_TISCI_DEVICE_H */
250 
tisci_msg_get_device_req::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:157
tisci_msg_set_device_resets_resp
Empty response for TISCI_MSG_SET_DEVICE_RESETS.
Definition: tisci_pm_device.h:216
tisci_msg_get_device_resp::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:181
tisci_msg_get_device_req
Request to get device based on id.
Definition: tisci_pm_device.h:156
tisci_msg_get_device_resp::context_loss_count
uint32_t context_loss_count
Definition: tisci_pm_device.h:182
tisci_msg_device_drop_powerup_ref_resp
Empty response for TISCI_MSG_DEVICE_DROP_POWERUP_REF.
Definition: tisci_pm_device.h:245
tisci_msg_set_device_req::state
uint8_t state
Definition: tisci_pm_device.h:133
tisci_msg_set_device_req::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:130
tisci_msg_set_device_resets_resp::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:217
tisci_header
Header that prefixes all TISCI messages.
Definition: tisci_protocol.h:89
tisci_msg_get_device_resp
Response to get device request.
Definition: tisci_pm_device.h:180
tisci_msg_set_device_resp
Empty response for TISCI_MSG_SET_DEVICE.
Definition: tisci_pm_device.h:144
tisci_msg_set_device_req
Set the desired state of the device.
Definition: tisci_pm_device.h:129
tisci_msg_device_drop_powerup_ref_resp::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:246
tisci_msg_device_drop_powerup_ref_req
Drop any remaining powerup device references.
Definition: tisci_pm_device.h:233
tisci_msg_set_device_req::reserved
uint32_t reserved
Definition: tisci_pm_device.h:132
tisci_msg_get_device_resp::programmed_state
uint8_t programmed_state
Definition: tisci_pm_device.h:184
tisci_msg_get_device_resp::current_state
uint8_t current_state
Definition: tisci_pm_device.h:185
tisci_msg_device_drop_powerup_ref_req::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:234
tisci_msg_set_device_resets_req::id
uint32_t id
Definition: tisci_pm_device.h:204
tisci_msg_set_device_resets_req::resets
uint32_t resets
Definition: tisci_pm_device.h:205
tisci_msg_set_device_resets_req::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:203
tisci_msg_set_device_req::id
uint32_t id
Definition: tisci_pm_device.h:131
tisci_msg_get_device_req::id
uint32_t id
Definition: tisci_pm_device.h:158
__attribute__
struct tisci_msg_set_device_req __attribute__((__packed__))
tisci_msg_get_device_resp::resets
uint32_t resets
Definition: tisci_pm_device.h:183
tisci_msg_set_device_resp::hdr
struct tisci_header hdr
Definition: tisci_pm_device.h:145
tisci_msg_set_device_resets_req
Set the desired state of the resets of a device.
Definition: tisci_pm_device.h:202