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