blob: cc81371116185c4994c4720853ca9c4b4edcd617 [file] [log] [blame]
Chris Kay82117d72021-12-01 16:34:55 +00001#
Yann Gautier9f359fd2022-01-27 09:25:47 +01002# Copyright (c) 2021-2022, Arm Limited. All rights reserved.
Chris Kay82117d72021-12-01 16:34:55 +00003#
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
Manish V Badarkhe67fec3e2021-12-31 16:08:51 +0000116 - title: Statistical profiling Extension (FEAT_SPE)
117 scope: spe
118
Chris Kay82117d72021-12-01 16:34:55 +0000119 - 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
Sieu Mun Tang9f3a13c2022-02-22 14:14:26 +0800188 - title: Intel
189 scope: intel
190
191 subsections:
192 - title: SoC
193 scope: soc
194
Chris Kay82117d72021-12-01 16:34:55 +0000195 - 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
Jiafei Pan18ba9e42022-02-10 10:39:56 +0800339 - 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
Jiafei Pan290bf6f2022-02-24 16:00:35 +0800352 - title: LS1088A
353 scope: ls1088a
354
355 subsections:
356 - title: LS1088ARDB
357 scope: ls1088ardb
358
359 - title: LS1088AQDS
360 scope: ls1088aqds
361
Chris Kay82117d72021-12-01 16:34:55 +0000362 - title: QEMU
363 scope: qemu
364
365 deprecated:
366 - plat/qemu
367
368 - title: QTI
369 scope: qti
370
371 subsections:
372 - title: SC1780
373 scope: sc7180
374
375 deprecated:
376 - plat/qti/sc7180
377
378 - title: SC7280
379 scope: sc7280
380
381 deprecated:
382 - plat/qti/sc7280
383
Stephan Gerholdd0d0bf42021-12-01 20:00:00 +0100384 - title: MSM8916
385 scope: msm8916
386
Chris Kay82117d72021-12-01 16:34:55 +0000387 - title: Raspberry Pi
388 scope: rpi
389
390 subsections:
391 - title: Raspberry Pi 4
392 scope: rpi4
393
394 - title: Renesas
395 scope: renesas
396
397 subsections:
398 - title: R-Car
399 scope: rcar
400
401 deprecated:
402 - plat/rcar
403
404 subsections:
405 - title: R-Car 3
406 scope: rcar3
407
408 deprecated:
409 - plat/rcar3
410
411 - title: Rockchip
412 scope: rockchip
413
414 subsections:
415 - title: RK3399
416 scope: rk3399
417
418 deprecated:
419 - rockchip/rk3399
420 - rk3399/suspend
421
422 - title: Socionext
423 scope: socionext
424
425 subsections:
426 - title: Synquacer
427 scope: synquacer
428
429 deprecated:
430 - plat/synquacer
431
432 - title: ST
433 scope: st
434
435 deprecated:
436 - plat/st
437
438 subsections:
439 - title: ST32MP1
440 scope: stm32mp1
441
442 deprecated:
443 - plat/st/stm32mp1
444
Dave Gerlach74c19f92022-03-22 11:02:52 -0500445 - title: Texas Instruments
446 scope: ti
447
448 subsections:
449 - title: K3
450 scope: k3
451
Chris Kay82117d72021-12-01 16:34:55 +0000452 - title: Xilinx
453 scope: xilinx
454
455 deprecated:
456 - plat/xilinx
457
458 subsections:
459 - title: Versal
460 scope: versal
461
462 deprecated:
463 - plat/xilinx/versal/include
464 - plat/xilinx/versal
465 - plat/versal
466
467 - title: ZynqMP
468 scope: zynqmp
469
470 deprecated:
471 - plat/zynqmp
472 - plat/xilinx/zynqmp
473
474 - title: Bootloader Images
475 scope: bl
476
477 deprecated:
478 - bl_common
479
480 subsections:
481 - title: BL1
482 scope: bl1
483
484 - title: BL2
485 scope: bl2
486
487 - title: Services
488 scope: services
489
490 subsections:
491 - title: FF-A
Daniel Boulby8d74d6a2021-12-06 14:44:35 +0000492 scope: ff-a
Chris Kay82117d72021-12-01 16:34:55 +0000493
494 deprecated:
Daniel Boulby8d74d6a2021-12-06 14:44:35 +0000495 - ffa
Chris Kay82117d72021-12-01 16:34:55 +0000496
497 - title: RME
498 scope: rme
499
500 - title: SPM
501 scope: spm
502
503 deprecated:
504 - spmc
505 - spmd
506 - SPMD
Daniel Boulby8d74d6a2021-12-06 14:44:35 +0000507
508 - title: SPM MM
509 scope: spm-mm
Chris Kay82117d72021-12-01 16:34:55 +0000510
511 - title: Libraries
512
513 subsections:
514 - title: CPU Support
515 scope: cpus
516
517 deprecated:
518 - cpu
519 - errata
520 - errata_report
521
522 - title: EL3 Runtime
523 scope: el3-runtime
524
525 deprecated:
526 - el3_runtime
527
528 - title: FCONF
529 scope: fconf
530
531 - title: MPMM
532 scope: mpmm
533
534 - title: OP-TEE
535 scope: optee
536
537 deprecated:
538 - lib/optee
539
540 - title: PSCI
541 scope: psci
542
543 - title: GPT
544 scope: gpt
545
546 deprecated:
547 - gpt_rme
548
549 - title: SMCCC
550 scope: smccc
551
552 - title: Translation Tables
553 scope: xlat
554
555 - title: Drivers
556
557 subsections:
558 - title: Authentication
559 scope: auth
560
561 deprecated:
562 - driver/auth
563
564 subsections:
565 - title: CryptoCell-713
566 scope: cc-713
567
568 - title: FWU
569 scope: fwu
570
571 deprecated:
572 - fwu_metadata
573
574 - title: I/O
575 scope: io
576
577 subsections:
578 - title: MTD
579 scope: mtd
580
581 deprecated:
582 - io_mtd
583
584 - title: Measured Boot
585 scope: measured-boot
586
587 deprecated:
588 - measured boot
589 - measured_boot
590
591 - title: MMC
592 scope: mmc
593
594 deprecated:
595 - drivers/mmc
596
597 - title: MTD
598 scope: mtd
599
600 deprecated:
601 - drivers/mtd
602
603 subsections:
604 - title: NAND
605 scope: nand
606
607 subsections:
608 - title: SPI NAND
609 scope: spi-nand
610
611 deprecated:
612 - spi_nand
613
Sughosh Ganu540e0322022-01-19 11:31:20 +0530614 - title: Partition
615 scope: partition
616
Chris Kay82117d72021-12-01 16:34:55 +0000617 - title: SCMI
618 scope: scmi
619
620 deprecated:
621 - scmi_common
622 - drivers/scmi-msg
623
624 - title: UFS
625 scope: ufs
626
627 - title: Arm
628 scope: arm-drivers
629
630 subsections:
631 - title: Ethos-N
632 scope: ethos-n
633
634 deprecated:
635 - drivers/arm/ethosn
636
637 - title: GIC
638 scope: gic
639
640 subsections:
641 - title: GICv3
642 scope: gicv3
643
644 subsections:
645 - title: GIC-600AE
646 scope: gic600ae
647
648 - title: TZC
649 scope: tzc
650
651 subsections:
652 - title: TZC-400
653 scope: tzc400
654
655 deprecated:
656 - drivers/tzc400
657
658 - title: Marvell
659 scope: marvell-drivers
660
661 subsections:
662 - title: COMPHY
663 scope: marvell-comphy
664
665 deprecated:
666 - drivers/marvell/comphy
667
668 subsections:
669 - title: Armada 3700
670 scope: marvell-comphy-3700
671
672 deprecated:
673 - drivers/marvell/comphy-3700
674
675 - title: CP110
676 scope: marvell-comphy-cp110
677
678 deprecated:
679 - drivers/marvell/comphy-cp110
680
681 - title: UART
682 scope: marvell-uart
683
684 deprecated:
685 - plat/marvell/uart
686
687 - title: Armada
688 scope: armada-drivers
689
690 subsections:
691 - title: A3K
692 scope: a3k-drivers
693
694 subsections:
695 - title: A3720
696 scope: a3720-uart
697
698 deprecated:
699 - plat/marvell/a3720/uart
700
701 - title: MediaTek
702 scope: mediatek-drivers
703
704 subsections:
705 - title: APU
706 scope: mediatek-apu
707
708 deprecated:
709 - plat/mediatek/apu
710
711 - title: EMI MPU
712 scope: mediatek-emi-mpu
713
714 deprecated:
715 - plat/mediatek/mpu
716
717 - title: PMIC Wrapper
718 scope: mediatek-pmic-wrapper
719
720 deprecated:
721 - plat/mediatek/pmic_wrap
722
723 - title: MT8192
724 scope: mt8192-drivers
725
726 subsections:
727 - title: SPM
728 scope: mt8192-spm
729
730 deprecated:
731 - mediatek/mt8192/spm
732
733 - title: NXP
734 scope: nxp-drivers
735
736 subsections:
737 - title: DCFG
738 scope: nxp-dcfg
739
740 deprecated:
741 - driver/nxp/dcfg
742
743 - title: FLEXSPI
744 scope: flexspi
745
746 deprecated:
747 - include/drivers/flexspi
748 - driver/nxp/xspi
749
750 - title: SCFG
751 scope: nxp-scfg
752
753 deprecated:
754 - nxp/scfg
755
756 - title: SFP
757 scope: nxp-sfp
758
759 deprecated:
760 - drivers/nxp/sfp
761
Jiafei Pan18ba9e42022-02-10 10:39:56 +0800762 - title: QSPI
763 scope: nxp-qspi
764
Jiafei Pan94450412022-02-18 12:02:04 +0800765 - title: NXP Crypto
766 scope: nxp-crypto
767
Jiafei Panfa3f7612022-02-22 11:05:00 +0800768 - title: DDR
769 scope: nxp-ddr
770
771 - title: GIC
772 scope: nxp-gic
773
Chris Kay82117d72021-12-01 16:34:55 +0000774 - title: Renesas
775 scope: renesas-drivers
776
777 subsections:
778 - title: R-Car3
779 scope: rcar3-drivers
780
781 deprecated:
782 - drivers/rcar3
783
784 - title: ST
785 scope: st-drivers
786
787 deprecated:
788 - drivers/st
789
790 subsections:
Yann Gautier9f359fd2022-01-27 09:25:47 +0100791 - title: BSEC
792 scope: st-bsec
793
Chris Kay82117d72021-12-01 16:34:55 +0000794 - title: Clock
795 scope: st-clock
796
797 deprecated:
798 - stm32mp_clk
799 - drivers/st/clk
800 - stm32mp1_clk
801
Yann Gautier9f359fd2022-01-27 09:25:47 +0100802 - title: Crypto
803 scope: st-crypto
804
805 - title: DDR
806 scope: st-ddr
807
Chris Kay82117d72021-12-01 16:34:55 +0000808 - title: I/O
809 scope: st-io-drivers
810
811 subsections:
812 - title: STM32 Image
813 scope: st-io-stm32image
814
815 deprecated:
816 - io-stm32image
817 - io_stm32image
818
819 - title: fiptool
820 scope: fiptool
821
Yann Gautier9f359fd2022-01-27 09:25:47 +0100822 - title: I2C
823 scope: st-i2c
824
825 - title: FMC
826 scope: st-fmc
827
828 - title: GPIO
829 scope: st-gpio
830
Chris Kay82117d72021-12-01 16:34:55 +0000831 - title: SDMMC2
832 scope: st-sdmmc2
833
834 deprecated:
835 - stm32_sdmmc2
836
837 - title: ST PMIC
838 scope: st-pmic
839
840 deprecated:
841 - drivers/st/pmic
842
843 - title: STPMIC1
844 scope: stpmic1
845
Yann Gautier9f359fd2022-01-27 09:25:47 +0100846 - title: Regulator
847 scope: st-regulator
848
849 - title: Reset
850 scope: st-reset
851
852 - title: SPI
853 scope: st-spi
854
Chris Kay82117d72021-12-01 16:34:55 +0000855 - title: UART
856 scope: st-uart
857
858 subsections:
859 - title: STM32 Console
860 scope: stm32-console
861
862 deprecated:
863 - stm32_console
864
865 - title: USB
866 scope: st-usb
867
868 deprecated:
869 - drivers/st/usb
870
Yann Gautier9f359fd2022-01-27 09:25:47 +0100871 - title: Watchdog
872 scope: st-iwdg
873
Chris Kay82117d72021-12-01 16:34:55 +0000874 - title: USB
875 scope: usb
876
877 deprecated:
878 - drivers/usb
879
880 - title: Miscellaneous
881
882 subsections:
883 - title: AArch64
884 scope: aarch64
885
886 - title: Debug
887 scope: debug
888
889 deprecated:
890 - common/debug
891
892 - title: CRC32
893 scope: crc32
894
895 subsections:
896 - title: Hardware CRC32
897 scope: hw-crc32
898
899 deprecated:
900 - hw_crc
901 - hw_crc32
902
903 - title: Software CRC32
904 scope: sw-crc32
905
906 deprecated:
907 - sw_crc32
908
909 - title: DT Bindings
910 scope: dt-bindings
911
912 - title: FDT Wrappers
913 scope: fdt-wrappers
914
915 - title: FDTs
916 scope: fdts
917
918 deprecated:
919 - fdt
920
921 subsections:
922 - title: Morello
923 scope: morello-fdts
924
925 deprecated:
926 - fdts/morello
927
928 - title: STM32MP1
929 scope: stm32mp1-fdts
930
931 deprecated:
932 - fdts stm32mp1
933
934 - title: PIE
935 scope: pie
936
937 - title: Security
938 scope: security
939
940 - title: SDEI
941 scope: sdei
942
943 - title: TBBR
944 scope: tbbr
945
946 - title: NXP
947
948 subsections:
949 - title: OCRAM
950 scope: nxp-ocram
951
952 deprecated:
953 - nxp/common/ocram
954
955 - title: PSCI
956 scope: nxp-psci
957
958 deprecated:
959 - plat/nxp/common/psci
960
961 - title: Documentation
962 scope: docs
963
964 deprecated:
965 - doc
966
967 subsections:
968 - title: Changelog
969 scope: changelog
970
971 - title: Commit Style
972 scope: commit-style
973
974 - title: Contribution Guidelines
975 scope: contributing
976
977 deprecated:
978 - contribution-guidelines
979 - docs-contributing.rst
980
981 - title: Maintainers
982 scope: maintainers
983
984 - title: Prerequisites
985 scope: prerequisites
986
Sandrine Bailleux3c8fdf72022-05-10 14:53:44 +0200987 - title: Threat Model
988 scope: threat-model
989
Chris Kay82117d72021-12-01 16:34:55 +0000990 - title: Build System
991 scope: build
992
993 deprecated:
994 - makefile
995 - Makefile
996
997 subsections:
998 - title: Git Hooks
999 scope: hooks
1000
1001 - title: Tools
1002
1003 subsections:
1004 - title: STM32 Image
1005 scope: stm32image
1006
1007 deprecated:
1008 - tools/stm32image
1009
Jiafei Pan18ba9e42022-02-10 10:39:56 +08001010 - title: NXP Tools
1011 scope: nxp-tools
1012
Chris Kay82117d72021-12-01 16:34:55 +00001013 - title: Dependencies
1014 scope: deps
1015
1016 subsections:
1017 - title: checkpatch
1018 scope: checkpatch
1019
1020 - title: commitlint
1021 scope: commitlint
1022
1023 - title: libfdt
1024 scope: libfdt
1025
1026 - title: Node Package Manager (NPM)
1027 scope: npm