xref: /rk3399_ARM-atf/changelog.yaml (revision 8ba55ec4945ec8238eb4a421883ecec5e5be114c)
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: Texas Instruments
436        scope: ti
437
438        subsections:
439          - title: K3
440            scope: k3
441
442      - title: Xilinx
443        scope: xilinx
444
445        deprecated:
446          - plat/xilinx
447
448        subsections:
449          - title: Versal
450            scope: versal
451
452            deprecated:
453              - plat/xilinx/versal/include
454              - plat/xilinx/versal
455              - plat/versal
456
457          - title: ZynqMP
458            scope: zynqmp
459
460            deprecated:
461              - plat/zynqmp
462              - plat/xilinx/zynqmp
463
464  - title: Bootloader Images
465    scope: bl
466
467    deprecated:
468      - bl_common
469
470    subsections:
471      - title: BL1
472        scope: bl1
473
474      - title: BL2
475        scope: bl2
476
477  - title: Services
478    scope: services
479
480    subsections:
481      - title: FF-A
482        scope: ff-a
483
484        deprecated:
485          - ffa
486
487      - title: RME
488        scope: rme
489
490      - title: SPM
491        scope: spm
492
493        deprecated:
494          - spmc
495          - spmd
496          - SPMD
497
498      - title: SPM MM
499        scope: spm-mm
500
501  - title: Libraries
502
503    subsections:
504      - title: CPU Support
505        scope: cpus
506
507        deprecated:
508          - cpu
509          - errata
510          - errata_report
511
512      - title: EL3 Runtime
513        scope: el3-runtime
514
515        deprecated:
516          - el3_runtime
517
518      - title: FCONF
519        scope: fconf
520
521      - title: MPMM
522        scope: mpmm
523
524      - title: OP-TEE
525        scope: optee
526
527        deprecated:
528          - lib/optee
529
530      - title: PSCI
531        scope: psci
532
533      - title: GPT
534        scope: gpt
535
536        deprecated:
537          - gpt_rme
538
539      - title: SMCCC
540        scope: smccc
541
542      - title: Translation Tables
543        scope: xlat
544
545  - title: Drivers
546
547    subsections:
548      - title: Authentication
549        scope: auth
550
551        deprecated:
552          - driver/auth
553
554        subsections:
555          - title: CryptoCell-713
556            scope: cc-713
557
558      - title: FWU
559        scope: fwu
560
561        deprecated:
562          - fwu_metadata
563
564      - title: I/O
565        scope: io
566
567        subsections:
568          - title: MTD
569            scope: mtd
570
571            deprecated:
572              - io_mtd
573
574      - title: Measured Boot
575        scope: measured-boot
576
577        deprecated:
578          - measured boot
579          - measured_boot
580
581      - title: MMC
582        scope: mmc
583
584        deprecated:
585          - drivers/mmc
586
587      - title: MTD
588        scope: mtd
589
590        deprecated:
591          - drivers/mtd
592
593        subsections:
594          - title: NAND
595            scope: nand
596
597            subsections:
598              - title: SPI NAND
599                scope: spi-nand
600
601                deprecated:
602                  - spi_nand
603
604      - title: Partition
605        scope: partition
606
607      - title: SCMI
608        scope: scmi
609
610        deprecated:
611          - scmi_common
612          - drivers/scmi-msg
613
614      - title: UFS
615        scope: ufs
616
617      - title: Arm
618        scope: arm-drivers
619
620        subsections:
621          - title: Ethos-N
622            scope: ethos-n
623
624            deprecated:
625              - drivers/arm/ethosn
626
627          - title: GIC
628            scope: gic
629
630            subsections:
631              - title: GICv3
632                scope: gicv3
633
634                subsections:
635                  - title: GIC-600AE
636                    scope: gic600ae
637
638          - title: TZC
639            scope: tzc
640
641            subsections:
642              - title: TZC-400
643                scope: tzc400
644
645                deprecated:
646                  - drivers/tzc400
647
648      - title: Marvell
649        scope: marvell-drivers
650
651        subsections:
652          - title: COMPHY
653            scope: marvell-comphy
654
655            deprecated:
656              - drivers/marvell/comphy
657
658            subsections:
659              - title: Armada 3700
660                scope: marvell-comphy-3700
661
662                deprecated:
663                  - drivers/marvell/comphy-3700
664
665              - title: CP110
666                scope: marvell-comphy-cp110
667
668                deprecated:
669                  - drivers/marvell/comphy-cp110
670
671          - title: UART
672            scope: marvell-uart
673
674            deprecated:
675              - plat/marvell/uart
676
677          - title: Armada
678            scope: armada-drivers
679
680            subsections:
681              - title: A3K
682                scope: a3k-drivers
683
684                subsections:
685                  - title: A3720
686                    scope: a3720-uart
687
688                    deprecated:
689                      - plat/marvell/a3720/uart
690
691      - title: MediaTek
692        scope: mediatek-drivers
693
694        subsections:
695          - title: APU
696            scope: mediatek-apu
697
698            deprecated:
699              - plat/mediatek/apu
700
701          - title: EMI MPU
702            scope: mediatek-emi-mpu
703
704            deprecated:
705              - plat/mediatek/mpu
706
707          - title: PMIC Wrapper
708            scope: mediatek-pmic-wrapper
709
710            deprecated:
711              - plat/mediatek/pmic_wrap
712
713          - title: MT8192
714            scope: mt8192-drivers
715
716            subsections:
717              - title: SPM
718                scope: mt8192-spm
719
720                deprecated:
721                  - mediatek/mt8192/spm
722
723      - title: NXP
724        scope: nxp-drivers
725
726        subsections:
727          - title: DCFG
728            scope: nxp-dcfg
729
730            deprecated:
731              - driver/nxp/dcfg
732
733          - title: FLEXSPI
734            scope: flexspi
735
736            deprecated:
737              - include/drivers/flexspi
738              - driver/nxp/xspi
739
740          - title: SCFG
741            scope: nxp-scfg
742
743            deprecated:
744              - nxp/scfg
745
746          - title: SFP
747            scope: nxp-sfp
748
749            deprecated:
750              - drivers/nxp/sfp
751
752          - title: QSPI
753            scope: nxp-qspi
754
755          - title: NXP Crypto
756            scope: nxp-crypto
757
758      - title: Renesas
759        scope: renesas-drivers
760
761        subsections:
762          - title: R-Car3
763            scope: rcar3-drivers
764
765            deprecated:
766              - drivers/rcar3
767
768      - title: ST
769        scope: st-drivers
770
771        deprecated:
772          - drivers/st
773
774        subsections:
775          - title: BSEC
776            scope: st-bsec
777
778          - title: Clock
779            scope: st-clock
780
781            deprecated:
782              - stm32mp_clk
783              - drivers/st/clk
784              - stm32mp1_clk
785
786          - title: Crypto
787            scope: st-crypto
788
789          - title: DDR
790            scope: st-ddr
791
792          - title: I/O
793            scope: st-io-drivers
794
795            subsections:
796              - title: STM32 Image
797                scope: st-io-stm32image
798
799                deprecated:
800                  - io-stm32image
801                  - io_stm32image
802
803              - title: fiptool
804                scope: fiptool
805
806          - title: I2C
807            scope: st-i2c
808
809          - title: FMC
810            scope: st-fmc
811
812          - title: GPIO
813            scope: st-gpio
814
815          - title: SDMMC2
816            scope: st-sdmmc2
817
818            deprecated:
819              - stm32_sdmmc2
820
821          - title: ST PMIC
822            scope: st-pmic
823
824            deprecated:
825              - drivers/st/pmic
826
827          - title: STPMIC1
828            scope: stpmic1
829
830          - title: Regulator
831            scope: st-regulator
832
833          - title: Reset
834            scope: st-reset
835
836          - title: SPI
837            scope: st-spi
838
839          - title: UART
840            scope: st-uart
841
842            subsections:
843              - title: STM32 Console
844                scope: stm32-console
845
846                deprecated:
847                  - stm32_console
848
849          - title: USB
850            scope: st-usb
851
852            deprecated:
853              - drivers/st/usb
854
855          - title: Watchdog
856            scope: st-iwdg
857
858      - title: USB
859        scope: usb
860
861        deprecated:
862          - drivers/usb
863
864  - title: Miscellaneous
865
866    subsections:
867      - title: AArch64
868        scope: aarch64
869
870      - title: Debug
871        scope: debug
872
873        deprecated:
874          - common/debug
875
876      - title: CRC32
877        scope: crc32
878
879        subsections:
880          - title: Hardware CRC32
881            scope: hw-crc32
882
883            deprecated:
884              - hw_crc
885              - hw_crc32
886
887          - title: Software CRC32
888            scope: sw-crc32
889
890            deprecated:
891              - sw_crc32
892
893      - title: DT Bindings
894        scope: dt-bindings
895
896      - title: FDT Wrappers
897        scope: fdt-wrappers
898
899      - title: FDTs
900        scope: fdts
901
902        deprecated:
903          - fdt
904
905        subsections:
906          - title: Morello
907            scope: morello-fdts
908
909            deprecated:
910              - fdts/morello
911
912          - title: STM32MP1
913            scope: stm32mp1-fdts
914
915            deprecated:
916              - fdts stm32mp1
917
918      - title: PIE
919        scope: pie
920
921      - title: Security
922        scope: security
923
924      - title: SDEI
925        scope: sdei
926
927      - title: TBBR
928        scope: tbbr
929
930      - title: NXP
931
932        subsections:
933          - title: OCRAM
934            scope: nxp-ocram
935
936            deprecated:
937              - nxp/common/ocram
938
939          - title: PSCI
940            scope: nxp-psci
941
942            deprecated:
943              - plat/nxp/common/psci
944
945  - title: Documentation
946    scope: docs
947
948    deprecated:
949      - doc
950
951    subsections:
952      - title: Changelog
953        scope: changelog
954
955      - title: Commit Style
956        scope: commit-style
957
958      - title: Contribution Guidelines
959        scope: contributing
960
961        deprecated:
962          - contribution-guidelines
963          - docs-contributing.rst
964
965      - title: Maintainers
966        scope: maintainers
967
968      - title: Prerequisites
969        scope: prerequisites
970
971  - title: Build System
972    scope: build
973
974    deprecated:
975      - makefile
976      - Makefile
977
978    subsections:
979      - title: Git Hooks
980        scope: hooks
981
982  - title: Tools
983
984    subsections:
985      - title: STM32 Image
986        scope: stm32image
987
988        deprecated:
989          - tools/stm32image
990
991      - title: NXP Tools
992        scope: nxp-tools
993
994  - title: Dependencies
995    scope: deps
996
997    subsections:
998      - title: checkpatch
999        scope: checkpatch
1000
1001      - title: commitlint
1002        scope: commitlint
1003
1004      - title: libfdt
1005        scope: libfdt
1006
1007      - title: Node Package Manager (NPM)
1008        scope: npm
1009