vendors/imx/imx95.rst

1 .. SPDX-License-Identifier: GPL-2.0
12 The System Manager (SM) is a low-level system function which runs on a System
15 runs on a Cortex-M processor and provides an abstraction to many of the
38 This protocol is intended provide access to the battery-backed module. This
43 - Describe the protocol version.
44 - Discover implementation attributes.
45 - Read/write GPR
46 - Discover the RTCs available in the system.
47 - Read/write the RTC time in seconds and ticks
48 - Set an alarm (per LM) in seconds
49 - Get notifications on RTC update, alarm, or rollover.
50 - Get notification on ON/OFF button activity.
52 For most SoC, there is one on-chip RTC (e.g. in BBNSM) and this is RTC ID 0.
70 +---------------+--------------------------------------------------------------+
72 +---------------+--------------------------------------------------------------+
74 +---------------+--------------------------------------------------------------+
76 +---------------+--------------------------------------------------------------+
79 +---------------+--------------------------------------------------------------+
87 +---------------+--------------------------------------------------------------+
89 +------------------+-----------------------------------------------------------+
91 +------------------+-----------------------------------------------------------+
93 +------------------+-----------------------------------------------------------+
96 +------------------+-----------------------------------------------------------+
104 +---------------+--------------------------------------------------------------+
106 +------------------+-----------------------------------------------------------+
108 +------------------+-----------------------------------------------------------+
113 +------------------+-----------------------------------------------------------+
117 +------------------+-----------------------------------------------------------+
125 +------------------+-----------------------------------------------------------+
127 +------------------+-----------------------------------------------------------+
129 +------------------+-----------------------------------------------------------+
131 +------------------+-----------------------------------------------------------+
132 |uint32 value      |32-bit value to write to the GPR                           |
133 +------------------+-----------------------------------------------------------+
135 +------------------+-----------------------------------------------------------+
137 +------------------+-----------------------------------------------------------+
142 +------------------+-----------------------------------------------------------+
150 +------------------+-----------------------------------------------------------+
152 +------------------+-----------------------------------------------------------+
154 +------------------+-----------------------------------------------------------+
156 +------------------+-----------------------------------------------------------+
158 +------------------+-----------------------------------------------------------+
160 +------------------+-----------------------------------------------------------+
165 +------------------+-----------------------------------------------------------+
166 |uint32 value      |32-bit value read from the GPR                             |
167 +------------------+-----------------------------------------------------------+
175 +------------------+-----------------------------------------------------------+
177 +------------------+-----------------------------------------------------------+
179 +------------------+-----------------------------------------------------------+
181 +------------------+-----------------------------------------------------------+
183 +------------------+-----------------------------------------------------------+
185 +------------------+-----------------------------------------------------------+
188 +------------------+-----------------------------------------------------------+
192 +------------------+-----------------------------------------------------------+
193 |uint8 name[16]    |Null-terminated ASCII string of up to 16 bytes in length   |
195 +------------------+-----------------------------------------------------------+
203 +------------------+-----------------------------------------------------------+
205 +------------------+-----------------------------------------------------------+
207 +------------------+-----------------------------------------------------------+
209 +------------------+-----------------------------------------------------------+
214 +------------------+-----------------------------------------------------------+
217 +------------------+-----------------------------------------------------------+
219 +------------------+-----------------------------------------------------------+
221 +------------------+-----------------------------------------------------------+
223 |                  |NOT_FOUND: rtcId pertains to a non-existent RTC.           |
227 +------------------+-----------------------------------------------------------+
235 +------------------+-----------------------------------------------------------+
237 +------------------+-----------------------------------------------------------+
239 +------------------+-----------------------------------------------------------+
241 +------------------+-----------------------------------------------------------+
246 +------------------+-----------------------------------------------------------+
248 +------------------+-----------------------------------------------------------+
250 +------------------+-----------------------------------------------------------+
252 |                  |NOT_FOUND: rtcId pertains to a non-existent RTC.           |
253 +------------------+-----------------------------------------------------------+
256 +------------------+-----------------------------------------------------------+
264 +------------------+-----------------------------------------------------------+
266 +------------------+-----------------------------------------------------------+
268 +------------------+-----------------------------------------------------------+
270 +------------------+-----------------------------------------------------------+
275 +------------------+-----------------------------------------------------------+
278 +------------------+-----------------------------------------------------------+
280 +------------------+-----------------------------------------------------------+
282 +------------------+-----------------------------------------------------------+
284 |                  |NOT_FOUND: rtcId pertains to a non-existent RTC.           |
289 +------------------+-----------------------------------------------------------+
297 +------------------+-----------------------------------------------------------+
299 +------------------+-----------------------------------------------------------+
301 +------------------+-----------------------------------------------------------+
304 +------------------+-----------------------------------------------------------+
306 +------------------+-----------------------------------------------------------+
314 +------------------+-----------------------------------------------------------+
316 +------------------+-----------------------------------------------------------+
318 +------------------+-----------------------------------------------------------+
320 +------------------+-----------------------------------------------------------+
332 +------------------+-----------------------------------------------------------+
334 +------------------+-----------------------------------------------------------+
336 +------------------+-----------------------------------------------------------+
339 |                  |NOT_FOUND: rtcId pertains to a non-existent RTC.           |
342 +------------------+-----------------------------------------------------------+
350 +------------------+-----------------------------------------------------------+
352 +------------------+-----------------------------------------------------------+
354 +------------------+-----------------------------------------------------------+
360 +------------------+-----------------------------------------------------------+
362 +------------------+-----------------------------------------------------------+
364 +------------------+-----------------------------------------------------------+
369 +------------------+-----------------------------------------------------------+
377 +--------------------+---------------------------------------------------------+
379 +--------------------+---------------------------------------------------------+
381 +--------------------+---------------------------------------------------------+
383 +--------------------+---------------------------------------------------------+
385 +--------------------+---------------------------------------------------------+
387 +--------------------+---------------------------------------------------------+
393 +--------------------+---------------------------------------------------------+
404 +------------------+-----------------------------------------------------------+
406 +------------------+-----------------------------------------------------------+
408 +------------------+-----------------------------------------------------------+
417 +------------------+-----------------------------------------------------------+
425 +------------------+-----------------------------------------------------------+
427 +------------------+-----------------------------------------------------------+
429 +------------------+-----------------------------------------------------------+
431 +------------------+-----------------------------------------------------------+
437 +------------------+-----------------------------------------------------------+
448 - Describe the protocol version.
449 - Discover implementation attributes.
450 - Set/Get a control.
451 - Initiate an action on a control.
452 - Obtain platform (i.e. SM) build information.
453 - Obtain ROM passover data.
454 - Read boot/shutdown/reset information for the LM or the system.
465 +---------------+--------------------------------------------------------------+
467 +---------------+--------------------------------------------------------------+
469 +---------------+--------------------------------------------------------------+
471 +---------------+--------------------------------------------------------------+
474 +---------------+--------------------------------------------------------------+
482 +------------------+-----------------------------------------------------------+
484 +------------------+-----------------------------------------------------------+
486 +------------------+-----------------------------------------------------------+
488 +------------------+-----------------------------------------------------------+
493 +------------------+-----------------------------------------------------------+
501 +------------------+-----------------------------------------------------------+
503 +------------------+-----------------------------------------------------------+
505 +------------------+-----------------------------------------------------------+
510 +------------------+-----------------------------------------------------------+
514 +------------------+-----------------------------------------------------------+
522 +------------------+-----------------------------------------------------------+
524 +------------------+-----------------------------------------------------------+
526 +------------------+-----------------------------------------------------------+
528 +------------------+-----------------------------------------------------------+
530 +------------------+-----------------------------------------------------------+
532 +------------------+-----------------------------------------------------------+
534 +------------------+-----------------------------------------------------------+
536 +------------------+-----------------------------------------------------------+
541 +------------------+-----------------------------------------------------------+
549 +------------------+-----------------------------------------------------------+
551 +------------------+-----------------------------------------------------------+
553 +------------------+-----------------------------------------------------------+
555 +------------------+-----------------------------------------------------------+
557 +------------------+-----------------------------------------------------------+
559 +------------------+-----------------------------------------------------------+
564 +------------------+-----------------------------------------------------------+
566 +------------------+-----------------------------------------------------------+
568 |val[0, num - 1]   |value data array                                           |
569 +------------------+-----------------------------------------------------------+
577 +------------------+-----------------------------------------------------------+
579 +------------------+-----------------------------------------------------------+
581 +------------------+-----------------------------------------------------------+
583 +------------------+-----------------------------------------------------------+
585 +------------------+-----------------------------------------------------------+
587 +------------------+-----------------------------------------------------------+
589 |arg[0, numarg -1] |Argument data array                                        |
590 +------------------+-----------------------------------------------------------+
592 +------------------+-----------------------------------------------------------+
594 +------------------+-----------------------------------------------------------+
599 +------------------+-----------------------------------------------------------+
601 +------------------+-----------------------------------------------------------+
603 |val[0, num - 1]   |value data array                                           |
604 +------------------+-----------------------------------------------------------+
614 +------------------+-----------------------------------------------------------+
616 +------------------+-----------------------------------------------------------+
618 +------------------+-----------------------------------------------------------+
621 +------------------+-----------------------------------------------------------+
623 +------------------+-----------------------------------------------------------+
625 +------------------+-----------------------------------------------------------+
628 +------------------+-----------------------------------------------------------+
631 +------------------+-----------------------------------------------------------+
644 +------------------+-----------------------------------------------------------+
646 +------------------+-----------------------------------------------------------+
648 +------------------+-----------------------------------------------------------+
651 +------------------+-----------------------------------------------------------+
653 +------------------+-----------------------------------------------------------+
655 |data[0, num - 1]  |Passover data array                                        |
656 +------------------+-----------------------------------------------------------+
664 +------------------+-----------------------------------------------------------+
666 +------------------+-----------------------------------------------------------+
668 +------------------+-----------------------------------------------------------+
670 +------------------+-----------------------------------------------------------+
672 +------------------+-----------------------------------------------------------+
674 +------------------+-----------------------------------------------------------+
676 +------------------+-----------------------------------------------------------+
684 +------------------+-----------------------------------------------------------+
692 +------------------+-----------------------------------------------------------+
694 +------------------+-----------------------------------------------------------+
696 +------------------+-----------------------------------------------------------+
698 +------------------+-----------------------------------------------------------+
700 +------------------+-----------------------------------------------------------+
702 +------------------+-----------------------------------------------------------+
704 |                  |NOT_FOUND: if reasonId pertains to a non-existent reason.  |
705 +------------------+-----------------------------------------------------------+
709 +------------------+-----------------------------------------------------------+
710 |uint8 name[16]    |Null-terminated ASCII string of up to 16 bytes in length   |
712 +------------------+-----------------------------------------------------------+
720 +--------------------+---------------------------------------------------------+
722 +--------------------+---------------------------------------------------------+
724 +--------------------+---------------------------------------------------------+
730 +--------------------+---------------------------------------------------------+
732 +--------------------+---------------------------------------------------------+
734 +--------------------+---------------------------------------------------------+
736 +--------------------+---------------------------------------------------------+
751 +--------------------+---------------------------------------------------------+
766 +--------------------+---------------------------------------------------------+
768 +--------------------+---------------------------------------------------------+
776 +--------------------+---------------------------------------------------------+
778 +--------------------+---------------------------------------------------------+
780 +--------------------+---------------------------------------------------------+
782 +--------------------+---------------------------------------------------------+
784 +--------------------+---------------------------------------------------------+
786 +--------------------+---------------------------------------------------------+
788 +--------------------+---------------------------------------------------------+
791 +--------------------+---------------------------------------------------------+
799 +--------------------+---------------------------------------------------------+
801 +--------------------+---------------------------------------------------------+
803 +--------------------+---------------------------------------------------------+
806 +--------------------+---------------------------------------------------------+
808 +--------------------+---------------------------------------------------------+
811 +--------------------+---------------------------------------------------------+
819 +--------------------+---------------------------------------------------------+
821 +--------------------+---------------------------------------------------------+
823 +--------------------+---------------------------------------------------------+
826 +--------------------+---------------------------------------------------------+
829 +--------------------+---------------------------------------------------------+
831 +--------------------+---------------------------------------------------------+
833 +--------------------+---------------------------------------------------------+
835 +--------------------+---------------------------------------------------------+
841 +--------------------+---------------------------------------------------------+
843 +--------------------+---------------------------------------------------------+
851 +--------------------+---------------------------------------------------------+
853 +--------------------+---------------------------------------------------------+
855 +--------------------+---------------------------------------------------------+
857 +--------------------+---------------------------------------------------------+
859 +--------------------+---------------------------------------------------------+
861 +--------------------+---------------------------------------------------------+
867 +--------------------+---------------------------------------------------------+
878 +------------------+-----------------------------------------------------------+
880 +------------------+-----------------------------------------------------------+
882 +------------------+-----------------------------------------------------------+
884 +------------------+-----------------------------------------------------------+
886 +------------------+-----------------------------------------------------------+