1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
|
.. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
===============================================================================
i.MX95 System Control and Management Interface(SCMI) Vendor Protocols Extension
===============================================================================
:Copyright: |copy| 2024 NXP
:Author: Peng Fan <peng.fan@nxp.com>
The System Manager (SM) is a low-level system function which runs on a System
Control Processor (SCP) to support isolation and management of power domains,
clocks, resets, sensors, pins, etc. on complex application processors. It often
runs on a Cortex-M processor and provides an abstraction to many of the
underlying features of the hardware. The primary purpose of the SM is to allow
isolation between software running on different cores in the SoC. It does this
by having exclusive access to critical resources such as those controlling
power, clocks, reset, PMIC, etc. and then providing an RPC interface to those
clients. This allows the SM to provide access control, arbitration, and
aggregation policies for those shared critical resources.
SM introduces a concept Logic Machine(LM) which is analogous to VM and each has
its own instance of SCMI. All normal SCMI calls only apply to that LM. That
includes boot, shutdown, reset, suspend, wake, etc. Each LM (e.g. A55 and M7)
are completely isolated from the others and each LM has its own communication
channels talking to the same SCMI server.
This document covers all the information necessary to understand, maintain,
port, and deploy the SM on supported processors.
The SM implements an interface compliant with the Arm SCMI Specification
with additional vendor specific extensions.
SCMI_BBM: System Control and Management BBM Vendor Protocol
==============================================================
This protocol is intended provide access to the battery-backed module. This
contains persistent storage (GPR), an RTC, and the ON/OFF button. The protocol
can also provide access to similar functions implemented via external board
components. The BBM protocol provides functions to:
- Describe the protocol version.
- Discover implementation attributes.
- Read/write GPR
- Discover the RTCs available in the system.
- Read/write the RTC time in seconds and ticks
- Set an alarm (per LM) in seconds
- Get notifications on RTC update, alarm, or rollover.
- Get notification on ON/OFF button activity.
For most SoC, there is one on-chip RTC (e.g. in BBNSM) and this is RTC ID 0.
Board code can add additional GPR and RTC.
GPR are not aggregated. The RTC time is also not aggregated. Setting these
sets for all so normally exclusive access would be granted to one agent for
each. However, RTC alarms are maintained for each LM and the hardware is
programmed with the next nearest alarm time. So only one agent in an LM should
be given access rights to set an RTC alarm.
Commands:
_________
PROTOCOL_VERSION
~~~~~~~~~~~~~~~~
message_id: 0x0
protocol_id: 0x81
+---------------+--------------------------------------------------------------+
|Return values |
+---------------+--------------------------------------------------------------+
|Name |Description |
+---------------+--------------------------------------------------------------+
|int32 status | See ARM SCMI Specification for status code definitions. |
+---------------+--------------------------------------------------------------+
|uint32 version | For this revision of the specification, this value must be |
| | 0x10000. |
+---------------+--------------------------------------------------------------+
PROTOCOL_ATTRIBUTES
~~~~~~~~~~~~~~~~~~~
message_id: 0x1
protocol_id: 0x81
+---------------+--------------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status | See ARM SCMI Specification for status code definitions. |
+------------------+-----------------------------------------------------------+
|uint32 attributes | Bits[31:8] Number of RTCs. |
| | Bits[15:0] Number of persistent storage (GPR) words. |
+------------------+-----------------------------------------------------------+
PROTOCOL_MESSAGE_ATTRIBUTES
~~~~~~~~~~~~~~~~~~~~~~~~~~~
message_id: 0x2
protocol_id: 0x81
+---------------+--------------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: in case the message is implemented and available |
| |to use. |
| |NOT_FOUND: if the message identified by message_id is |
| |invalid or not implemented |
+------------------+-----------------------------------------------------------+
|uint32 attributes |Flags that are associated with a specific function in the |
| |protocol. For all functions in this protocol, this |
| |parameter has a value of 0 |
+------------------+-----------------------------------------------------------+
BBM_GPR_SET
~~~~~~~~~~~
message_id: 0x3
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of GPR to write |
+------------------+-----------------------------------------------------------+
|uint32 value |32-bit value to write to the GPR |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: if the GPR was successfully written. |
| |NOT_FOUND: if the index is not valid. |
| |DENIED: if the agent does not have permission to write |
| |the specified GPR |
+------------------+-----------------------------------------------------------+
BBM_GPR_GET
~~~~~~~~~~~
message_id: 0x4
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of GPR to read |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: if the GPR was successfully read. |
| |NOT_FOUND: if the index is not valid. |
| |DENIED: if the agent does not have permission to read |
| |the specified GPR. |
+------------------+-----------------------------------------------------------+
|uint32 value |32-bit value read from the GPR |
+------------------+-----------------------------------------------------------+
BBM_RTC_ATTRIBUTES
~~~~~~~~~~~~~~~~~~
message_id: 0x5
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of RTC |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: returned the attributes. |
| |NOT_FOUND: Index is invalid. |
+------------------+-----------------------------------------------------------+
|uint32 attributes |Bit[31:24] Bit width of RTC seconds. |
| |Bit[23:16] Bit width of RTC ticks. |
| |Bits[15:0] RTC ticks per second |
+------------------+-----------------------------------------------------------+
|uint8 name[16] |Null-terminated ASCII string of up to 16 bytes in length |
| |describing the RTC name |
+------------------+-----------------------------------------------------------+
BBM_RTC_TIME_SET
~~~~~~~~~~~~~~~~
message_id: 0x6
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of RTC |
+------------------+-----------------------------------------------------------+
|uint32 flags |Bits[31:1] Reserved, must be zero. |
| |Bit[0] RTC time format: |
| |Set to 1 if the time is in ticks. |
| |Set to 0 if the time is in seconds |
+------------------+-----------------------------------------------------------+
|uint32 time[2] |Lower word: Lower 32 bits of the time in seconds/ticks. |
| |Upper word: Upper 32 bits of the time in seconds/ticks. |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: RTC time was successfully set. |
| |NOT_FOUND: rtcId pertains to a non-existent RTC. |
| |INVALID_PARAMETERS: time is not valid |
| |(beyond the range of the RTC). |
| |DENIED: the agent does not have permission to set the RTC. |
+------------------+-----------------------------------------------------------+
BBM_RTC_TIME_GET
~~~~~~~~~~~~~~~~
message_id: 0x7
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of RTC |
+------------------+-----------------------------------------------------------+
|uint32 flags |Bits[31:1] Reserved, must be zero. |
| |Bit[0] RTC time format: |
| |Set to 1 if the time is in ticks. |
| |Set to 0 if the time is in seconds |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: RTC time was successfully get. |
| |NOT_FOUND: rtcId pertains to a non-existent RTC. |
+------------------+-----------------------------------------------------------+
|uint32 time[2] |Lower word: Lower 32 bits of the time in seconds/ticks. |
| |Upper word: Upper 32 bits of the time in seconds/ticks. |
+------------------+-----------------------------------------------------------+
BBM_RTC_ALARM_SET
~~~~~~~~~~~~~~~~~
message_id: 0x8
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of RTC |
+------------------+-----------------------------------------------------------+
|uint32 flags |Bits[31:1] Reserved, must be zero. |
| |Bit[0] RTC enable flag: |
| |Set to 1 if the RTC alarm should be enabled. |
| |Set to 0 if the RTC alarm should be disabled |
+------------------+-----------------------------------------------------------+
|uint32 time[2] |Lower word: Lower 32 bits of the time in seconds. |
| |Upper word: Upper 32 bits of the time in seconds. |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: RTC time was successfully set. |
| |NOT_FOUND: rtcId pertains to a non-existent RTC. |
| |INVALID_PARAMETERS: time is not valid |
| |(beyond the range of the RTC). |
| |DENIED: the agent does not have permission to set the RTC |
| |alarm |
+------------------+-----------------------------------------------------------+
BBM_BUTTON_GET
~~~~~~~~~~~~~~
message_id: 0x9
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: if the button status was read. |
| |Other value: ARM SCMI Specification status code definitions|
+------------------+-----------------------------------------------------------+
|uint32 state |State of the ON/OFF button. 1: ON, 0: OFF |
+------------------+-----------------------------------------------------------+
BBM_RTC_NOTIFY
~~~~~~~~~~~~~~
message_id: 0xA
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of RTC |
+------------------+-----------------------------------------------------------+
|uint32 flags |Notification flags |
| |Bits[31:3] Reserved, must be zero. |
| |Bit[2] Update enable: |
| |Set to 1 to send notification. |
| |Set to 0 if no notification. |
| |Bit[1] Rollover enable: |
| |Set to 1 to send notification. |
| |Set to 0 if no notification. |
| |Bit[0] Alarm enable: |
| |Set to 1 to send notification. |
| |Set to 0 if no notification |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: notification configuration was successfully |
| |updated. |
| |NOT_FOUND: rtcId pertains to a non-existent RTC. |
| |DENIED: the agent does not have permission to request RTC |
| |notifications. |
+------------------+-----------------------------------------------------------+
BBM_BUTTON_NOTIFY
~~~~~~~~~~~~~~~~~
message_id: 0xB
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 flags |Notification flags |
| |Bits[31:1] Reserved, must be zero. |
| |Bit[0] Enable button: |
| |Set to 1 to send notification. |
| |Set to 0 if no notification |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: notification configuration was successfully |
| |updated. |
| |DENIED: the agent does not have permission to request |
| |button notifications. |
+------------------+-----------------------------------------------------------+
NEGOTIATE_PROTOCOL_VERSION
~~~~~~~~~~~~~~~~~~~~~~~~~~
message_id: 0x10
protocol_id: 0x81
+--------------------+---------------------------------------------------------+
|Parameters |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|uint32 version |The negotiated protocol version the agent intends to use |
+--------------------+---------------------------------------------------------+
|Return values |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|int32 status |SUCCESS: if the negotiated protocol version is supported |
| |by the platform. All commands, responses, and |
| |notifications post successful return of this command must|
| |comply with the negotiated version. |
| |NOT_SUPPORTED: if the protocol version is not supported. |
+--------------------+---------------------------------------------------------+
Notifications
_____________
BBM_RTC_EVENT
~~~~~~~~~~~~~
message_id: 0x0
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 flags |RTC events: |
| |Bits[31:2] Reserved, must be zero. |
| |Bit[1] RTC rollover notification: |
| |1 RTC rollover detected. |
| |0 no RTC rollover detected. |
| |Bit[0] RTC alarm notification: |
| |1 RTC alarm generated. |
| |0 no RTC alarm generated. |
+------------------+-----------------------------------------------------------+
BBM_BUTTON_EVENT
~~~~~~~~~~~~~~~~
message_id: 0x1
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 flags |RTC events: |
+------------------+-----------------------------------------------------------+
| |Button events: |
| |Bits[31:1] Reserved, must be zero. |
| |Bit[0] Button notification: |
| |1 button change detected. |
| |0 no button change detected. |
+------------------+-----------------------------------------------------------+
SCMI_MISC: System Control and Management MISC Vendor Protocol
================================================================
Provides miscellaneous functions. This includes controls that are miscellaneous
settings/actions that must be exposed from the SM to agents. They are device
specific and are usually define to access bit fields in various mix block
control modules, IOMUX_GPR, and other GPR/CSR owned by the SM. This protocol
supports the following functions:
- Describe the protocol version.
- Discover implementation attributes.
- Set/Get a control.
- Initiate an action on a control.
- Obtain platform (i.e. SM) build information.
- Obtain ROM passover data.
- Read boot/shutdown/reset information for the LM or the system.
Commands:
_________
PROTOCOL_VERSION
~~~~~~~~~~~~~~~~
message_id: 0x0
protocol_id: 0x84
+---------------+--------------------------------------------------------------+
|Return values |
+---------------+--------------------------------------------------------------+
|Name |Description |
+---------------+--------------------------------------------------------------+
|int32 status | See ARM SCMI Specification for status code definitions. |
+---------------+--------------------------------------------------------------+
|uint32 version | For this revision of the specification, this value must be |
| | 0x10000. |
+---------------+--------------------------------------------------------------+
PROTOCOL_ATTRIBUTES
~~~~~~~~~~~~~~~~~~~
message_id: 0x1
protocol_id: 0x84
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status | See ARM SCMI Specification for status code definitions. |
+------------------+-----------------------------------------------------------+
|uint32 attributes |Protocol attributes: |
| |Bits[31:24] Reserved, must be zero. |
| |Bits[23:16] Number of reset reasons. |
| |Bits[15:0] Number of controls |
+------------------+-----------------------------------------------------------+
PROTOCOL_MESSAGE_ATTRIBUTES
~~~~~~~~~~~~~~~~~~~~~~~~~~~
message_id: 0x2
protocol_id: 0x84
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: in case the message is implemented and available |
| |to use. |
| |NOT_FOUND: if the message identified by message_id is |
| |invalid or not implemented |
+------------------+-----------------------------------------------------------+
|uint32 attributes |Flags that are associated with a specific function in the |
| |protocol. For all functions in this protocol, this |
| |parameter has a value of 0 |
+------------------+-----------------------------------------------------------+
MISC_CONTROL_SET
~~~~~~~~~~~~~~~~
message_id: 0x3
protocol_id: 0x84
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of the control |
+------------------+-----------------------------------------------------------+
|uint32 num |Size of the value data in words |
+------------------+-----------------------------------------------------------+
|uint32 val[8] |value data array |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: if the control was set successfully. |
| |NOT_FOUND: if the index is not valid. |
| |DENIED: if the agent does not have permission to set the |
| |control |
+------------------+-----------------------------------------------------------+
MISC_CONTROL_GET
~~~~~~~~~~~~~~~~
message_id: 0x4
protocol_id: 0x84
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of the control |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: if the control was get successfully. |
| |NOT_FOUND: if the index is not valid. |
| |DENIED: if the agent does not have permission to get the |
| |control |
+------------------+-----------------------------------------------------------+
|uint32 num |Size of the return data in words, max 8 |
+------------------+-----------------------------------------------------------+
|uint32 | |
|val[0, num - 1] |value data array |
+------------------+-----------------------------------------------------------+
MISC_CONTROL_ACTION
~~~~~~~~~~~~~~~~~~~
message_id: 0x5
protocol_id: 0x84
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of the control |
+------------------+-----------------------------------------------------------+
|uint32 action |Action for the control |
+------------------+-----------------------------------------------------------+
|uint32 numarg |Size of the argument data, max 8 |
+------------------+-----------------------------------------------------------+
|uint32 | |
|arg[0, numarg -1] |Argument data array |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: if the action was set successfully. |
| |NOT_FOUND: if the index is not valid. |
| |DENIED: if the agent does not have permission to get the |
| |control |
+------------------+-----------------------------------------------------------+
|uint32 num |Size of the return data in words, max 8 |
+------------------+-----------------------------------------------------------+
|uint32 | |
|val[0, num - 1] |value data array |
+------------------+-----------------------------------------------------------+
MISC_DISCOVER_BUILD_INFO
~~~~~~~~~~~~~~~~~~~~~~~~
This function is used to obtain the build commit, data, time, number.
message_id: 0x6
protocol_id: 0x84
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: if the build info was got successfully. |
| |NOT_SUPPORTED: if the data is not available. |
+------------------+-----------------------------------------------------------+
|uint32 buildnum |Build number |
+------------------+-----------------------------------------------------------+
|uint32 buildcommit|Most significant 32 bits of the git commit hash |
+------------------+-----------------------------------------------------------+
|uint8 date[16] |Date of build. Null terminated ASCII string of up to 16 |
| |bytes in length |
+------------------+-----------------------------------------------------------+
|uint8 time[16] |Time of build. Null terminated ASCII string of up to 16 |
| |bytes in length |
+------------------+-----------------------------------------------------------+
MISC_ROM_PASSOVER_GET
~~~~~~~~~~~~~~~~~~~~~
ROM passover data is information exported by ROM and could be used by others.
It includes boot device, instance, type, mode and etc. This function is used
to obtain the ROM passover data. The returned block of words is structured as
defined in the ROM passover section in the SoC RM.
message_id: 0x7
protocol_id: 0x84
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: if the data was got successfully. |
| |NOT_SUPPORTED: if the data is not available. |
+------------------+-----------------------------------------------------------+
|uint32 num |Size of the passover data in words, max 13 |
+------------------+-----------------------------------------------------------+
|uint32 | |
|data[0, num - 1] |Passover data array |
+------------------+-----------------------------------------------------------+
MISC_CONTROL_NOTIFY
~~~~~~~~~~~~~~~~~~~
message_id: 0x8
protocol_id: 0x84
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 index |Index of control |
+------------------+-----------------------------------------------------------+
|uint32 flags |Notification flags, varies by control |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: notification configuration was successfully |
| |updated. |
| |NOT_FOUND: control id not exists. |
| |INVALID_PARAMETERS: if the input attributes flag specifies |
| |unsupported or invalid configurations.. |
| |DENIED: if the calling agent is not permitted to request |
| |the notification. |
+------------------+-----------------------------------------------------------+
MISC_RESET_REASON_ATTRIBUTES
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
message_id: 0x9
protocol_id: 0x84
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 reasonid |Identifier for the reason |
+------------------+-----------------------------------------------------------+
|Return values |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|int32 status |SUCCESS: if valid reason attributes are returned |
| |NOT_FOUND: if reasonId pertains to a non-existent reason. |
+------------------+-----------------------------------------------------------+
|uint32 attributes |Reason attributes. This parameter has the following |
| |format: Bits[31:0] Reserved, must be zero |
| |Bits[15:0] Number of persistent storage (GPR) words. |
+------------------+-----------------------------------------------------------+
|uint8 name[16] |Null-terminated ASCII string of up to 16 bytes in length |
| |describing the reason |
+------------------+-----------------------------------------------------------+
MISC_RESET_REASON_GET
~~~~~~~~~~~~~~~~~~~~~
message_id: 0xA
protocol_id: 0x84
+--------------------+---------------------------------------------------------+
|Parameters |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|uint32 flags |Reason flags. This parameter has the following format: |
| |Bits[31:1] Reserved, must be zero. |
| |Bit[0] System: |
| |Set to 1 to return the system reason. |
| |Set to 0 to return the LM reason |
+--------------------+---------------------------------------------------------+
|Return values |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|int32 status |SUCCESS: reset reason return |
+--------------------+---------------------------------------------------------+
|uint32 bootflags |Boot reason flags. This parameter has the format: |
| |Bits[31] Valid. |
| |Set to 1 if the entire reason is valid. |
| |Set to 0 if the entire reason is not valid. |
| |Bits[30:29] Reserved, must be zero. |
| |Bit[28] Valid origin: |
| |Set to 1 if the origin field is valid. |
| |Set to 0 if the origin field is not valid. |
| |Bits[27:24] Origin. |
| |Bit[23] Valid err ID: |
| |Set to 1 if the error ID field is valid. |
| |Set to 0 if the error ID field is not valid. |
| |Bits[22:8] Error ID. |
| |Bit[7:0] Reason |
+--------------------+---------------------------------------------------------+
|uint32 shutdownflags|Shutdown reason flags. This parameter has the format: |
| |Bits[31] Valid. |
| |Set to 1 if the entire reason is valid. |
| |Set to 0 if the entire reason is not valid. |
| |Bits[30:29] Number of valid extended info words. |
| |Bit[28] Valid origin: |
| |Set to 1 if the origin field is valid. |
| |Set to 0 if the origin field is not valid. |
| |Bits[27:24] Origin. |
| |Bit[23] Valid err ID: |
| |Set to 1 if the error ID field is valid. |
| |Set to 0 if the error ID field is not valid. |
| |Bits[22:8] Error ID. |
| |Bit[7:0] Reason |
+--------------------+---------------------------------------------------------+
|uint32 extinfo[8] |Array of extended info words |
+--------------------+---------------------------------------------------------+
MISC_SI_INFO_GET
~~~~~~~~~~~~~~~~
message_id: 0xB
protocol_id: 0x84
+--------------------+---------------------------------------------------------+
|Return values |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|int32 status |SUCCESS: silicon info return |
+--------------------+---------------------------------------------------------+
|uint32 deviceid |Silicon specific device ID |
+--------------------+---------------------------------------------------------+
|uint32 sirev |Silicon specific revision |
+--------------------+---------------------------------------------------------+
|uint32 partnum |Silicon specific part number |
+--------------------+---------------------------------------------------------+
|uint8 siname[16] |Silicon name/revision. Null terminated ASCII string of up|
| |to 16 bytes in length |
+--------------------+---------------------------------------------------------+
MISC_CFG_INFO_GET
~~~~~~~~~~~~~~~~~
message_id: 0xC
protocol_id: 0x84
+--------------------+---------------------------------------------------------+
|Return values |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|int32 status |SUCCESS: config name return |
| |NOT_SUPPORTED: name not available |
+--------------------+---------------------------------------------------------+
|uint32 msel |Mode selector value |
+--------------------+---------------------------------------------------------+
|uint8 cfgname[16] |config file basename. Null terminated ASCII string of up |
| |to 16 bytes in length |
+--------------------+---------------------------------------------------------+
MISC_SYSLOG_GET
~~~~~~~~~~~~~~~
message_id: 0xD
protocol_id: 0x84
+--------------------+---------------------------------------------------------+
|Parameters |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|uint32 flags |Device specific flags that might impact the data returned|
| |or clearing of the data |
+--------------------+---------------------------------------------------------+
|uint32 logindex |Index to the first log word. Will be the first element in|
| |the return array |
+--------------------+---------------------------------------------------------+
|Return values |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|int32 status |SUCCESS: system log return |
+--------------------+---------------------------------------------------------+
|uint32 numLogflags |Descriptor for the log data returned by this call. |
| |Bits[31:20] Number of remaining log words. |
| |Bits[15:12] Reserved, must be zero. |
| |Bits[11:0] Number of log words that are returned by this |
| |call |
+--------------------+---------------------------------------------------------+
|uint32 syslog[N] |Log data array, N is defined in bits[11:0] of numLogflags|
+--------------------+---------------------------------------------------------+
NEGOTIATE_PROTOCOL_VERSION
~~~~~~~~~~~~~~~~~~~~~~~~~~
message_id: 0x10
protocol_id: 0x84
+--------------------+---------------------------------------------------------+
|Parameters |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|uint32 version |The negotiated protocol version the agent intends to use |
+--------------------+---------------------------------------------------------+
|Return values |
+--------------------+---------------------------------------------------------+
|Name |Description |
+--------------------+---------------------------------------------------------+
|int32 status |SUCCESS: if the negotiated protocol version is supported |
| |by the platform. All commands, responses, and |
| |notifications post successful return of this command must|
| |comply with the negotiated version. |
| |NOT_SUPPORTED: if the protocol version is not supported. |
+--------------------+---------------------------------------------------------+
Notifications
_____________
MISC_CONTROL_EVENT
~~~~~~~~~~~~~~~~~~
message_id: 0x0
protocol_id: 0x81
+------------------+-----------------------------------------------------------+
|Parameters |
+------------------+-----------------------------------------------------------+
|Name |Description |
+------------------+-----------------------------------------------------------+
|uint32 ctrlid |Identifier for the control that caused the event. |
+------------------+-----------------------------------------------------------+
|uint32 flags |Event flags, varies by control. |
+------------------+-----------------------------------------------------------+
|
