xref: /rk3399_ARM-atf/changelog.yaml (revision 6a00e9b0c8c37fc446f83ef63e95a75353e31e8b)
1#
2# Copyright (c) 2021-2022, Arm Limited. All rights reserved.
3#
4# SPDX-License-Identifier: BSD-3-Clause
5#
6
7#
8# The following block describes the top-level sections of the changelog. Commits are categorized
9# into these top-level sections based on the commit message "type":
10#
11#     feat(xyz): add the xyz feature
12#     ^^^^
13#
14
15sections:
16  - title: New Features
17    description: A new feature
18    type: feat
19
20  - title: Resolved Issues
21    description: A bug fix
22    type: fix
23
24  - title: Build System
25    description: Changes that affect the build system or external dependencies
26    type: build
27    hidden: true
28
29  - title: Continuous Integration
30    description: Changes to our CI configuration files and scripts
31    type: ci
32    hidden: true
33
34  - title: Build System
35    description: Documentation-only changes
36    type: docs
37    hidden: true
38
39  - title: Performance Improvements
40    description: A code change that improves performance
41    type: perf
42    hidden: true
43
44  - title: Code Refactoring
45    description: A code change that neither fixes a bug nor adds a feature
46    type: refactor
47    hidden: true
48
49  - title: Reverted Changes
50    description: Changes that revert a previous change
51    type: revert
52    hidden: true
53
54  - title: Style
55    description: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
56    type: style
57    hidden: true
58
59  - title: Tests
60    description: Adding missing tests or correcting existing tests
61    type: test
62    hidden: true
63
64  - title: Miscellaneous
65    description: Any other change
66    type: chore
67    hidden: true
68
69#
70# The following block describes the sub-sections of the changelog. These sub-sections may appear in
71# any of the top-level sections, and describe the individual components that a change may relate to.
72#
73# Sub-sections have an optional associated commit message "scope":
74#
75#     feat(xyz): add the xyz feature
76#          ^^^
77#
78# This file also describes deprecated scopes, which are scopes that were used before we introduced
79# scope enforcement. These will not pass CI checks when used, but they will be used to generate the
80# changelog.
81#
82# Please note that new scopes should be kebab-case: https://en.wiktionary.org/wiki/kebab_case
83#
84
85subsections:
86  - title: Architecture
87
88    subsections:
89      - title: Activity Monitors Extension (FEAT_AMU)
90        scope: amu
91
92      - title: Support for the `HCRX_EL2` register (FEAT_HCX)
93        scope: hcx
94
95      - title: Memory Partitioning and Monitoring (MPAM) Extension (FEAT_MPAM)
96        scope: mpam
97
98      - title: Scalable Matrix Extension (FEAT_SME)
99        scope: sme
100
101      - title: Scalable Vector Extension (FEAT_SVE)
102        scope: sve
103
104      - title: System Register Trace Extensions (FEAT_ETMv4, FEAT_ETE and FEAT_ETEv1.1)
105        scope: sys-reg-trace
106
107        deprecated:
108          - sys_reg_trace
109
110      - title: Trace Buffer Extension (FEAT_TRBE)
111        scope: trbe
112
113      - title: Self-hosted Trace Extensions (FEAT_TRF)
114        scope: trf
115
116      - title: Statistical profiling Extension (FEAT_SPE)
117        scope: spe
118
119  - title: Platforms
120
121    subsections:
122      - title: Allwinner
123        scope: allwinner
124
125        deprecated:
126          - plat/allwinner
127
128      - title: Arm
129        scope: arm
130
131        deprecated:
132          - plat/arm
133
134        subsections:
135          - title: FPGA
136            scope: fpga
137
138            deprecated:
139              - arm_fgpa
140              - arm_fpga
141              - plat/arm_fpga
142
143          - title: FVP
144            scope: fvp
145
146            deprecated:
147              - plat/fvp
148
149          - title: FVP-R
150            scope: fvp-r
151
152            deprecated:
153              - fvp_r
154
155          - title: Juno
156            scope: juno
157
158          - title: Morello
159            scope: morello
160
161          - title: RD
162            scope: rd
163
164            subsections:
165              - title: RD-N2
166                scope: rdn2
167
168                deprecated:
169                  - board/rdn2
170
171          - title: SGI
172            scope: sgi
173
174            deprecated:
175              - plat/sgi
176              - plat/arm/sgi
177
178          - title: TC
179            scope: tc
180
181            subsections:
182              - title: TC0
183                scope: tc0
184
185                deprecated:
186                  - plat/tc0
187
188      - title: Intel
189        scope: intel
190
191        subsections:
192          - title: SoC
193            scope: soc
194
195      - title: Marvell
196        scope: marvell
197
198        deprecated:
199          - plat/marvell
200
201        subsections:
202          - title: Armada
203            scope: armada
204
205            deprecated:
206              - plat/marvell/armada
207
208            subsections:
209              - title: A3K
210                scope: a3k
211
212                deprecated:
213                  - plat/marvell/a3k
214
215              - title: A8K
216                scope: a8k
217
218                deprecated:
219                  - plat/marvell/a8k
220
221      - title: MediaTek
222        scope: mediatek
223
224        deprecated:
225          - plat/mediatek/common
226          - plat/mediatek
227
228        subsections:
229          - title: MT8183
230            scope: mt8183
231
232            deprecated:
233              - plat/mediatek/mt8183
234
235          - title: MT8192
236            scope: mt8192
237
238            deprecated:
239              - plat/mdeiatek/mt8192
240
241          - title: MT8195
242            scope: mt8195
243
244            deprecated:
245              - plat/mediatek/me8195
246              - plat/mediatek/mt8195
247              - plat/mdeiatek/mt8195
248
249      - title: NVIDIA
250        scope: nvidia
251
252        subsections:
253          - title: Tegra
254            scope: tegra
255
256            deprecated:
257              - plat/tegra
258
259            subsections:
260              - title: Tegra 132
261                scope: tegra132
262
263      - title: NXP
264        scope: nxp
265
266        deprecated:
267          - plat/nxp
268          - plat/nxp/common
269
270        subsections:
271          - title: i.MX
272            scope: imx
273
274            deprecated:
275              - plat/imx
276              - plat/imx/imx
277
278            subsections:
279              - title: i.MX 8M
280                scope: imx8m
281
282                deprecated:
283                  - plat/imx8m
284                  - plat/imx/imx8m
285
286                subsections:
287                  - title: i.MX 8M Mini
288                    scope: imx8mm
289
290                    deprecated:
291                      - plat/imx/imx8m/imx8mm
292
293                  - title: i.MX 8M Plus
294                    scope: imx8mp
295
296                    deprecated:
297                      - plat/imx/imx8m/imx8mp
298
299          - title: Layerscape
300            scope: layerscape
301
302            deprecated:
303              - docs/nxp/layerscape
304
305            subsections:
306              - title: LS1028A
307                scope: ls1028a
308
309                deprecated:
310                  - plat/nxp/ls1028a
311
312                subsections:
313                  - title: LS1028ARDB
314                    scope: ls1028ardb
315
316                    deprecated:
317                      - plat/nxp/ls1028ardb
318
319              - title: LX2
320                scope: lx2
321
322                deprecated:
323                  - plat/nxp/lx2
324
325                subsections:
326                  - title: LX216
327                    scope: lx216
328
329                    deprecated:
330                      - plat/nxp/lx216x
331
332                    subsections:
333                      - title: LX2160
334                        scope: lx2160
335
336                        deprecated:
337                          - plat/soc-lx2160
338
339              - title: LS1046A
340                scope: ls1046a
341
342                subsections:
343                  - title: LS1046ARDB
344                    scope: ls1046ardb
345
346                  - title: LS1046AFRWY
347                    scope: ls1046afrwy
348
349                  - title: LS1046AQDS
350                    scope: ls1046aqds
351
352      - title: QEMU
353        scope: qemu
354
355        deprecated:
356          - plat/qemu
357
358      - title: QTI
359        scope: qti
360
361        subsections:
362          - title: SC1780
363            scope: sc7180
364
365            deprecated:
366              - plat/qti/sc7180
367
368          - title: SC7280
369            scope: sc7280
370
371            deprecated:
372              - plat/qti/sc7280
373
374          - title: MSM8916
375            scope: msm8916
376
377      - title: Raspberry Pi
378        scope: rpi
379
380        subsections:
381          - title: Raspberry Pi 4
382            scope: rpi4
383
384      - title: Renesas
385        scope: renesas
386
387        subsections:
388          - title: R-Car
389            scope: rcar
390
391            deprecated:
392              - plat/rcar
393
394            subsections:
395              - title: R-Car 3
396                scope: rcar3
397
398                deprecated:
399                  - plat/rcar3
400
401      - title: Rockchip
402        scope: rockchip
403
404        subsections:
405          - title: RK3399
406            scope: rk3399
407
408            deprecated:
409              - rockchip/rk3399
410              - rk3399/suspend
411
412      - title: Socionext
413        scope: socionext
414
415        subsections:
416          - title: Synquacer
417            scope: synquacer
418
419            deprecated:
420              - plat/synquacer
421
422      - title: ST
423        scope: st
424
425        deprecated:
426          - plat/st
427
428        subsections:
429          - title: ST32MP1
430            scope: stm32mp1
431
432            deprecated:
433              - plat/st/stm32mp1
434
435      - title: Xilinx
436        scope: xilinx
437
438        deprecated:
439          - plat/xilinx
440
441        subsections:
442          - title: Versal
443            scope: versal
444
445            deprecated:
446              - plat/xilinx/versal/include
447              - plat/xilinx/versal
448              - plat/versal
449
450          - title: ZynqMP
451            scope: zynqmp
452
453            deprecated:
454              - plat/zynqmp
455              - plat/xilinx/zynqmp
456
457  - title: Bootloader Images
458    scope: bl
459
460    deprecated:
461      - bl_common
462
463    subsections:
464      - title: BL1
465        scope: bl1
466
467      - title: BL2
468        scope: bl2
469
470  - title: Services
471    scope: services
472
473    subsections:
474      - title: FF-A
475        scope: ff-a
476
477        deprecated:
478          - ffa
479
480      - title: RME
481        scope: rme
482
483      - title: SPM
484        scope: spm
485
486        deprecated:
487          - spmc
488          - spmd
489          - SPMD
490
491      - title: SPM MM
492        scope: spm-mm
493
494  - title: Libraries
495
496    subsections:
497      - title: CPU Support
498        scope: cpus
499
500        deprecated:
501          - cpu
502          - errata
503          - errata_report
504
505      - title: EL3 Runtime
506        scope: el3-runtime
507
508        deprecated:
509          - el3_runtime
510
511      - title: FCONF
512        scope: fconf
513
514      - title: MPMM
515        scope: mpmm
516
517      - title: OP-TEE
518        scope: optee
519
520        deprecated:
521          - lib/optee
522
523      - title: PSCI
524        scope: psci
525
526      - title: GPT
527        scope: gpt
528
529        deprecated:
530          - gpt_rme
531
532      - title: SMCCC
533        scope: smccc
534
535      - title: Translation Tables
536        scope: xlat
537
538  - title: Drivers
539
540    subsections:
541      - title: Authentication
542        scope: auth
543
544        deprecated:
545          - driver/auth
546
547        subsections:
548          - title: CryptoCell-713
549            scope: cc-713
550
551      - title: FWU
552        scope: fwu
553
554        deprecated:
555          - fwu_metadata
556
557      - title: I/O
558        scope: io
559
560        subsections:
561          - title: MTD
562            scope: mtd
563
564            deprecated:
565              - io_mtd
566
567      - title: Measured Boot
568        scope: measured-boot
569
570        deprecated:
571          - measured boot
572          - measured_boot
573
574      - title: MMC
575        scope: mmc
576
577        deprecated:
578          - drivers/mmc
579
580      - title: MTD
581        scope: mtd
582
583        deprecated:
584          - drivers/mtd
585
586        subsections:
587          - title: NAND
588            scope: nand
589
590            subsections:
591              - title: SPI NAND
592                scope: spi-nand
593
594                deprecated:
595                  - spi_nand
596
597      - title: Partition
598        scope: partition
599
600      - title: SCMI
601        scope: scmi
602
603        deprecated:
604          - scmi_common
605          - drivers/scmi-msg
606
607      - title: UFS
608        scope: ufs
609
610      - title: Arm
611        scope: arm-drivers
612
613        subsections:
614          - title: Ethos-N
615            scope: ethos-n
616
617            deprecated:
618              - drivers/arm/ethosn
619
620          - title: GIC
621            scope: gic
622
623            subsections:
624              - title: GICv3
625                scope: gicv3
626
627                subsections:
628                  - title: GIC-600AE
629                    scope: gic600ae
630
631          - title: TZC
632            scope: tzc
633
634            subsections:
635              - title: TZC-400
636                scope: tzc400
637
638                deprecated:
639                  - drivers/tzc400
640
641      - title: Marvell
642        scope: marvell-drivers
643
644        subsections:
645          - title: COMPHY
646            scope: marvell-comphy
647
648            deprecated:
649              - drivers/marvell/comphy
650
651            subsections:
652              - title: Armada 3700
653                scope: marvell-comphy-3700
654
655                deprecated:
656                  - drivers/marvell/comphy-3700
657
658              - title: CP110
659                scope: marvell-comphy-cp110
660
661                deprecated:
662                  - drivers/marvell/comphy-cp110
663
664          - title: UART
665            scope: marvell-uart
666
667            deprecated:
668              - plat/marvell/uart
669
670          - title: Armada
671            scope: armada-drivers
672
673            subsections:
674              - title: A3K
675                scope: a3k-drivers
676
677                subsections:
678                  - title: A3720
679                    scope: a3720-uart
680
681                    deprecated:
682                      - plat/marvell/a3720/uart
683
684      - title: MediaTek
685        scope: mediatek-drivers
686
687        subsections:
688          - title: APU
689            scope: mediatek-apu
690
691            deprecated:
692              - plat/mediatek/apu
693
694          - title: EMI MPU
695            scope: mediatek-emi-mpu
696
697            deprecated:
698              - plat/mediatek/mpu
699
700          - title: PMIC Wrapper
701            scope: mediatek-pmic-wrapper
702
703            deprecated:
704              - plat/mediatek/pmic_wrap
705
706          - title: MT8192
707            scope: mt8192-drivers
708
709            subsections:
710              - title: SPM
711                scope: mt8192-spm
712
713                deprecated:
714                  - mediatek/mt8192/spm
715
716      - title: NXP
717        scope: nxp-drivers
718
719        subsections:
720          - title: DCFG
721            scope: nxp-dcfg
722
723            deprecated:
724              - driver/nxp/dcfg
725
726          - title: FLEXSPI
727            scope: flexspi
728
729            deprecated:
730              - include/drivers/flexspi
731              - driver/nxp/xspi
732
733          - title: SCFG
734            scope: nxp-scfg
735
736            deprecated:
737              - nxp/scfg
738
739          - title: SFP
740            scope: nxp-sfp
741
742            deprecated:
743              - drivers/nxp/sfp
744
745          - title: QSPI
746            scope: nxp-qspi
747
748          - title: NXP Crypto
749            scope: nxp-crypto
750
751      - title: Renesas
752        scope: renesas-drivers
753
754        subsections:
755          - title: R-Car3
756            scope: rcar3-drivers
757
758            deprecated:
759              - drivers/rcar3
760
761      - title: ST
762        scope: st-drivers
763
764        deprecated:
765          - drivers/st
766
767        subsections:
768          - title: BSEC
769            scope: st-bsec
770
771          - title: Clock
772            scope: st-clock
773
774            deprecated:
775              - stm32mp_clk
776              - drivers/st/clk
777              - stm32mp1_clk
778
779          - title: Crypto
780            scope: st-crypto
781
782          - title: DDR
783            scope: st-ddr
784
785          - title: I/O
786            scope: st-io-drivers
787
788            subsections:
789              - title: STM32 Image
790                scope: st-io-stm32image
791
792                deprecated:
793                  - io-stm32image
794                  - io_stm32image
795
796              - title: fiptool
797                scope: fiptool
798
799          - title: I2C
800            scope: st-i2c
801
802          - title: FMC
803            scope: st-fmc
804
805          - title: GPIO
806            scope: st-gpio
807
808          - title: SDMMC2
809            scope: st-sdmmc2
810
811            deprecated:
812              - stm32_sdmmc2
813
814          - title: ST PMIC
815            scope: st-pmic
816
817            deprecated:
818              - drivers/st/pmic
819
820          - title: STPMIC1
821            scope: stpmic1
822
823          - title: Regulator
824            scope: st-regulator
825
826          - title: Reset
827            scope: st-reset
828
829          - title: SPI
830            scope: st-spi
831
832          - title: UART
833            scope: st-uart
834
835            subsections:
836              - title: STM32 Console
837                scope: stm32-console
838
839                deprecated:
840                  - stm32_console
841
842          - title: USB
843            scope: st-usb
844
845            deprecated:
846              - drivers/st/usb
847
848          - title: Watchdog
849            scope: st-iwdg
850
851      - title: USB
852        scope: usb
853
854        deprecated:
855          - drivers/usb
856
857  - title: Miscellaneous
858
859    subsections:
860      - title: AArch64
861        scope: aarch64
862
863      - title: Debug
864        scope: debug
865
866        deprecated:
867          - common/debug
868
869      - title: CRC32
870        scope: crc32
871
872        subsections:
873          - title: Hardware CRC32
874            scope: hw-crc32
875
876            deprecated:
877              - hw_crc
878              - hw_crc32
879
880          - title: Software CRC32
881            scope: sw-crc32
882
883            deprecated:
884              - sw_crc32
885
886      - title: DT Bindings
887        scope: dt-bindings
888
889      - title: FDT Wrappers
890        scope: fdt-wrappers
891
892      - title: FDTs
893        scope: fdts
894
895        deprecated:
896          - fdt
897
898        subsections:
899          - title: Morello
900            scope: morello-fdts
901
902            deprecated:
903              - fdts/morello
904
905          - title: STM32MP1
906            scope: stm32mp1-fdts
907
908            deprecated:
909              - fdts stm32mp1
910
911      - title: PIE
912        scope: pie
913
914      - title: Security
915        scope: security
916
917      - title: SDEI
918        scope: sdei
919
920      - title: TBBR
921        scope: tbbr
922
923      - title: NXP
924
925        subsections:
926          - title: OCRAM
927            scope: nxp-ocram
928
929            deprecated:
930              - nxp/common/ocram
931
932          - title: PSCI
933            scope: nxp-psci
934
935            deprecated:
936              - plat/nxp/common/psci
937
938  - title: Documentation
939    scope: docs
940
941    deprecated:
942      - doc
943
944    subsections:
945      - title: Changelog
946        scope: changelog
947
948      - title: Commit Style
949        scope: commit-style
950
951      - title: Contribution Guidelines
952        scope: contributing
953
954        deprecated:
955          - contribution-guidelines
956          - docs-contributing.rst
957
958      - title: Maintainers
959        scope: maintainers
960
961      - title: Prerequisites
962        scope: prerequisites
963
964  - title: Build System
965    scope: build
966
967    deprecated:
968      - makefile
969      - Makefile
970
971    subsections:
972      - title: Git Hooks
973        scope: hooks
974
975  - title: Tools
976
977    subsections:
978      - title: STM32 Image
979        scope: stm32image
980
981        deprecated:
982          - tools/stm32image
983
984      - title: NXP Tools
985        scope: nxp-tools
986
987  - title: Dependencies
988    scope: deps
989
990    subsections:
991      - title: checkpatch
992        scope: checkpatch
993
994      - title: commitlint
995        scope: commitlint
996
997      - title: libfdt
998        scope: libfdt
999
1000      - title: Node Package Manager (NPM)
1001        scope: npm
1002