blob: 81e3a979bb9826e3305213b45bbf11bc84443deb [file] [log] [blame]
Chris Kay82117d72021-12-01 16:34:55 +00001#
2# Copyright (c) 2021, 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: Platforms
117
118 subsections:
119 - title: Allwinner
120 scope: allwinner
121
122 deprecated:
123 - plat/allwinner
124
125 - title: Arm
126 scope: arm
127
128 deprecated:
129 - plat/arm
130
131 subsections:
132 - title: FPGA
133 scope: fpga
134
135 deprecated:
136 - arm_fgpa
137 - arm_fpga
138 - plat/arm_fpga
139
140 - title: FVP
141 scope: fvp
142
143 deprecated:
144 - plat/fvp
145
146 - title: FVP-R
147 scope: fvp-r
148
149 deprecated:
150 - fvp_r
151
152 - title: Juno
153 scope: juno
154
155 - title: Morello
156 scope: morello
157
158 - title: RD
159 scope: rd
160
161 subsections:
162 - title: RD-N2
163 scope: rdn2
164
165 deprecated:
166 - board/rdn2
167
168 - title: SGI
169 scope: sgi
170
171 deprecated:
172 - plat/sgi
173 - plat/arm/sgi
174
175 - title: TC
176 scope: tc
177
178 subsections:
179 - title: TC0
180 scope: tc0
181
182 deprecated:
183 - plat/tc0
184
185 - title: Marvell
186 scope: marvell
187
188 deprecated:
189 - plat/marvell
190
191 subsections:
192 - title: Armada
193 scope: armada
194
195 deprecated:
196 - plat/marvell/armada
197
198 subsections:
199 - title: A3K
200 scope: a3k
201
202 deprecated:
203 - plat/marvell/a3k
204
205 - title: A8K
206 scope: a8k
207
208 deprecated:
209 - plat/marvell/a8k
210
211 - title: MediaTek
212 scope: mediatek
213
214 deprecated:
215 - plat/mediatek/common
216 - plat/mediatek
217
218 subsections:
219 - title: MT8183
220 scope: mt8183
221
222 deprecated:
223 - plat/mediatek/mt8183
224
225 - title: MT8192
226 scope: mt8192
227
228 deprecated:
229 - plat/mdeiatek/mt8192
230
231 - title: MT8195
232 scope: mt8195
233
234 deprecated:
235 - plat/mediatek/me8195
236 - plat/mediatek/mt8195
237 - plat/mdeiatek/mt8195
238
239 - title: NVIDIA
240 scope: nvidia
241
242 subsections:
243 - title: Tegra
244 scope: tegra
245
246 deprecated:
247 - plat/tegra
248
249 subsections:
250 - title: Tegra 132
251 scope: tegra132
252
253 - title: NXP
254 scope: nxp
255
256 deprecated:
257 - plat/nxp
258 - plat/nxp/common
259
260 subsections:
261 - title: i.MX
262 scope: imx
263
264 deprecated:
265 - plat/imx
266 - plat/imx/imx
267
268 subsections:
269 - title: i.MX 8M
270 scope: imx8m
271
272 deprecated:
273 - plat/imx8m
274 - plat/imx/imx8m
275
276 subsections:
277 - title: i.MX 8M Mini
278 scope: imx8mm
279
280 deprecated:
281 - plat/imx/imx8m/imx8mm
282
283 - title: i.MX 8M Plus
284 scope: imx8mp
285
286 deprecated:
287 - plat/imx/imx8m/imx8mp
288
289 - title: Layerscape
290 scope: layerscape
291
292 deprecated:
293 - docs/nxp/layerscape
294
295 subsections:
296 - title: LS1028A
297 scope: ls1028a
298
299 deprecated:
300 - plat/nxp/ls1028a
301
302 subsections:
303 - title: LS1028ARDB
304 scope: ls1028ardb
305
306 deprecated:
307 - plat/nxp/ls1028ardb
308
309 - title: LX2
310 scope: lx2
311
312 deprecated:
313 - plat/nxp/lx2
314
315 subsections:
316 - title: LX216
317 scope: lx216
318
319 deprecated:
320 - plat/nxp/lx216x
321
322 subsections:
323 - title: LX2160
324 scope: lx2160
325
326 deprecated:
327 - plat/soc-lx2160
328
Jiafei Pan18ba9e42022-02-10 10:39:56 +0800329 - title: LS1046A
330 scope: ls1046a
331
332 subsections:
333 - title: LS1046ARDB
334 scope: ls1046ardb
335
336 - title: LS1046AFRWY
337 scope: ls1046afrwy
338
339 - title: LS1046AQDS
340 scope: ls1046aqds
341
Chris Kay82117d72021-12-01 16:34:55 +0000342 - title: QEMU
343 scope: qemu
344
345 deprecated:
346 - plat/qemu
347
348 - title: QTI
349 scope: qti
350
351 subsections:
352 - title: SC1780
353 scope: sc7180
354
355 deprecated:
356 - plat/qti/sc7180
357
358 - title: SC7280
359 scope: sc7280
360
361 deprecated:
362 - plat/qti/sc7280
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: ffa
463
464 deprecated:
465 - ff-a
466
467 - title: RME
468 scope: rme
469
470 - title: SPM
471 scope: spm
472
473 deprecated:
474 - spmc
475 - spmd
476 - SPMD
477 - spm_mm
478
479 - title: Libraries
480
481 subsections:
482 - title: CPU Support
483 scope: cpus
484
485 deprecated:
486 - cpu
487 - errata
488 - errata_report
489
490 - title: EL3 Runtime
491 scope: el3-runtime
492
493 deprecated:
494 - el3_runtime
495
496 - title: FCONF
497 scope: fconf
498
499 - title: MPMM
500 scope: mpmm
501
502 - title: OP-TEE
503 scope: optee
504
505 deprecated:
506 - lib/optee
507
508 - title: PSCI
509 scope: psci
510
511 - title: GPT
512 scope: gpt
513
514 deprecated:
515 - gpt_rme
516
517 - title: SMCCC
518 scope: smccc
519
520 - title: Translation Tables
521 scope: xlat
522
523 - title: Drivers
524
525 subsections:
526 - title: Authentication
527 scope: auth
528
529 deprecated:
530 - driver/auth
531
532 subsections:
533 - title: CryptoCell-713
534 scope: cc-713
535
536 - title: FWU
537 scope: fwu
538
539 deprecated:
540 - fwu_metadata
541
542 - title: I/O
543 scope: io
544
545 subsections:
546 - title: MTD
547 scope: mtd
548
549 deprecated:
550 - io_mtd
551
552 - title: Measured Boot
553 scope: measured-boot
554
555 deprecated:
556 - measured boot
557 - measured_boot
558
559 - title: MMC
560 scope: mmc
561
562 deprecated:
563 - drivers/mmc
564
565 - title: MTD
566 scope: mtd
567
568 deprecated:
569 - drivers/mtd
570
571 subsections:
572 - title: NAND
573 scope: nand
574
575 subsections:
576 - title: SPI NAND
577 scope: spi-nand
578
579 deprecated:
580 - spi_nand
581
Sughosh Ganu540e0322022-01-19 11:31:20 +0530582 - title: Partition
583 scope: partition
584
Chris Kay82117d72021-12-01 16:34:55 +0000585 - title: SCMI
586 scope: scmi
587
588 deprecated:
589 - scmi_common
590 - drivers/scmi-msg
591
592 - title: UFS
593 scope: ufs
594
595 - title: Arm
596 scope: arm-drivers
597
598 subsections:
599 - title: Ethos-N
600 scope: ethos-n
601
602 deprecated:
603 - drivers/arm/ethosn
604
605 - title: GIC
606 scope: gic
607
608 subsections:
609 - title: GICv3
610 scope: gicv3
611
612 subsections:
613 - title: GIC-600AE
614 scope: gic600ae
615
616 - title: TZC
617 scope: tzc
618
619 subsections:
620 - title: TZC-400
621 scope: tzc400
622
623 deprecated:
624 - drivers/tzc400
625
626 - title: Marvell
627 scope: marvell-drivers
628
629 subsections:
630 - title: COMPHY
631 scope: marvell-comphy
632
633 deprecated:
634 - drivers/marvell/comphy
635
636 subsections:
637 - title: Armada 3700
638 scope: marvell-comphy-3700
639
640 deprecated:
641 - drivers/marvell/comphy-3700
642
643 - title: CP110
644 scope: marvell-comphy-cp110
645
646 deprecated:
647 - drivers/marvell/comphy-cp110
648
649 - title: UART
650 scope: marvell-uart
651
652 deprecated:
653 - plat/marvell/uart
654
655 - title: Armada
656 scope: armada-drivers
657
658 subsections:
659 - title: A3K
660 scope: a3k-drivers
661
662 subsections:
663 - title: A3720
664 scope: a3720-uart
665
666 deprecated:
667 - plat/marvell/a3720/uart
668
669 - title: MediaTek
670 scope: mediatek-drivers
671
672 subsections:
673 - title: APU
674 scope: mediatek-apu
675
676 deprecated:
677 - plat/mediatek/apu
678
679 - title: EMI MPU
680 scope: mediatek-emi-mpu
681
682 deprecated:
683 - plat/mediatek/mpu
684
685 - title: PMIC Wrapper
686 scope: mediatek-pmic-wrapper
687
688 deprecated:
689 - plat/mediatek/pmic_wrap
690
691 - title: MT8192
692 scope: mt8192-drivers
693
694 subsections:
695 - title: SPM
696 scope: mt8192-spm
697
698 deprecated:
699 - mediatek/mt8192/spm
700
701 - title: NXP
702 scope: nxp-drivers
703
704 subsections:
705 - title: DCFG
706 scope: nxp-dcfg
707
708 deprecated:
709 - driver/nxp/dcfg
710
711 - title: FLEXSPI
712 scope: flexspi
713
714 deprecated:
715 - include/drivers/flexspi
716 - driver/nxp/xspi
717
718 - title: SCFG
719 scope: nxp-scfg
720
721 deprecated:
722 - nxp/scfg
723
724 - title: SFP
725 scope: nxp-sfp
726
727 deprecated:
728 - drivers/nxp/sfp
729
Jiafei Pan18ba9e42022-02-10 10:39:56 +0800730 - title: QSPI
731 scope: nxp-qspi
732
Chris Kay82117d72021-12-01 16:34:55 +0000733 - title: Renesas
734 scope: renesas-drivers
735
736 subsections:
737 - title: R-Car3
738 scope: rcar3-drivers
739
740 deprecated:
741 - drivers/rcar3
742
743 - title: ST
744 scope: st-drivers
745
746 deprecated:
747 - drivers/st
748
749 subsections:
750 - title: Clock
751 scope: st-clock
752
753 deprecated:
754 - stm32mp_clk
755 - drivers/st/clk
756 - stm32mp1_clk
757
758 - title: I/O
759 scope: st-io-drivers
760
761 subsections:
762 - title: STM32 Image
763 scope: st-io-stm32image
764
765 deprecated:
766 - io-stm32image
767 - io_stm32image
768
769 - title: fiptool
770 scope: fiptool
771
772 - title: SDMMC2
773 scope: st-sdmmc2
774
775 deprecated:
776 - stm32_sdmmc2
777
778 - title: ST PMIC
779 scope: st-pmic
780
781 deprecated:
782 - drivers/st/pmic
783
784 - title: STPMIC1
785 scope: stpmic1
786
787 - title: UART
788 scope: st-uart
789
790 subsections:
791 - title: STM32 Console
792 scope: stm32-console
793
794 deprecated:
795 - stm32_console
796
797 - title: USB
798 scope: st-usb
799
800 deprecated:
801 - drivers/st/usb
802
803 - title: USB
804 scope: usb
805
806 deprecated:
807 - drivers/usb
808
809 - title: Miscellaneous
810
811 subsections:
812 - title: AArch64
813 scope: aarch64
814
815 - title: Debug
816 scope: debug
817
818 deprecated:
819 - common/debug
820
821 - title: CRC32
822 scope: crc32
823
824 subsections:
825 - title: Hardware CRC32
826 scope: hw-crc32
827
828 deprecated:
829 - hw_crc
830 - hw_crc32
831
832 - title: Software CRC32
833 scope: sw-crc32
834
835 deprecated:
836 - sw_crc32
837
838 - title: DT Bindings
839 scope: dt-bindings
840
841 - title: FDT Wrappers
842 scope: fdt-wrappers
843
844 - title: FDTs
845 scope: fdts
846
847 deprecated:
848 - fdt
849
850 subsections:
851 - title: Morello
852 scope: morello-fdts
853
854 deprecated:
855 - fdts/morello
856
857 - title: STM32MP1
858 scope: stm32mp1-fdts
859
860 deprecated:
861 - fdts stm32mp1
862
863 - title: PIE
864 scope: pie
865
866 - title: Security
867 scope: security
868
869 - title: SDEI
870 scope: sdei
871
872 - title: TBBR
873 scope: tbbr
874
875 - title: NXP
876
877 subsections:
878 - title: OCRAM
879 scope: nxp-ocram
880
881 deprecated:
882 - nxp/common/ocram
883
884 - title: PSCI
885 scope: nxp-psci
886
887 deprecated:
888 - plat/nxp/common/psci
889
890 - title: Documentation
891 scope: docs
892
893 deprecated:
894 - doc
895
896 subsections:
897 - title: Changelog
898 scope: changelog
899
900 - title: Commit Style
901 scope: commit-style
902
903 - title: Contribution Guidelines
904 scope: contributing
905
906 deprecated:
907 - contribution-guidelines
908 - docs-contributing.rst
909
910 - title: Maintainers
911 scope: maintainers
912
913 - title: Prerequisites
914 scope: prerequisites
915
916 - title: Build System
917 scope: build
918
919 deprecated:
920 - makefile
921 - Makefile
922
923 subsections:
924 - title: Git Hooks
925 scope: hooks
926
927 - title: Tools
928
929 subsections:
930 - title: STM32 Image
931 scope: stm32image
932
933 deprecated:
934 - tools/stm32image
935
Jiafei Pan18ba9e42022-02-10 10:39:56 +0800936 - title: NXP Tools
937 scope: nxp-tools
938
Chris Kay82117d72021-12-01 16:34:55 +0000939 - title: Dependencies
940 scope: deps
941
942 subsections:
943 - title: checkpatch
944 scope: checkpatch
945
946 - title: commitlint
947 scope: commitlint
948
949 - title: libfdt
950 scope: libfdt
951
952 - title: Node Package Manager (NPM)
953 scope: npm