mchp_pic32cm_pl_clock.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Microchip Technology Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef INCLUDE_ZEPHYR_DT_BINDINGS_CLOCK_MCHP_PIC32CM_PL_CLOCK_H_
#define INCLUDE_ZEPHYR_DT_BINDINGS_CLOCK_MCHP_PIC32CM_PL_CLOCK_H_
 
/* Clock subsystem Types */
#define SUBSYS_TYPE_OSCHF      (0)
#define SUBSYS_TYPE_RTC        (1)
#define SUBSYS_TYPE_XOSC32K    (2)
#define SUBSYS_TYPE_OSC32K     (3)
#define SUBSYS_TYPE_GCLKGEN    (4)
#define SUBSYS_TYPE_GCLKPERIPH (5)
#define SUBSYS_TYPE_MCLKCPU    (6)
#define SUBSYS_TYPE_MCLKPERIPH (7)
#define SUBSYS_TYPE_MAX        (7)
 
#define MBUS_AHB  (0)
#define MBUS_APBA (1)
#define MBUS_APBB (2)
#define MBUS_APBC (3)
#define MBUS_MAX  (3)
 
#define INST_XOSC32K_XOSC1K  0
#define INST_XOSC32K_XOSC32K 1
 
#define INST_OSC32K_OSC1K  0
#define INST_OSC32K_OSC32K 1
 
#define MCHP_CLOCK_DERIVE_ID(type, mclkbus, mclkmaskbit, gclkperiph, inst)                         \
        (((type) << 26) | ((mclkbus) << 20) | ((mclkmaskbit) << 14) | ((gclkperiph) << 8) | inst)
 
#define CLOCK_MCHP_OSCHF_ID     MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_OSCHF, 0x3f, 0x3f, 0x3f, 0)
#define CLOCK_MCHP_OSCHF_ID_MAX (0)
 
#define CLOCK_MCHP_RTC_ID     MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_RTC, 0x3f, 0x3f, 0x3f, 0)
#define CLOCK_MCHP_RTC_ID_MAX (0)
 
#define CLOCK_MCHP_XOSC32K_ID_XOSC1K                                                               \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_XOSC32K, 0x3f, 0x3f, 0x3f, INST_XOSC32K_XOSC1K)
#define CLOCK_MCHP_XOSC32K_ID_XOSC32K                                                              \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_XOSC32K, 0x3f, 0x3f, 0x3f, INST_XOSC32K_XOSC32K)
#define CLOCK_MCHP_XOSC32K_ID_MAX (1)
 
#define CLOCK_MCHP_OSC32K_ID_OSC1K                                                                 \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_OSC32K, 0x3f, 0x3f, 0x3f, INST_OSC32K_OSC1K)
#define CLOCK_MCHP_OSC32K_ID_OSC32K                                                                \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_OSC32K, 0x3f, 0x3f, 0x3f, INST_OSC32K_OSC32K)
#define CLOCK_MCHP_OSC32K_ID_MAX (1)
 
#define CLOCK_MCHP_GCLKGEN_ID_GEN0 MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKGEN, 0x3f, 0x3f, 0x3f, 0)
#define CLOCK_MCHP_GCLKGEN_ID_GEN1 MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKGEN, 0x3f, 0x3f, 0x3f, 1)
#define CLOCK_MCHP_GCLKGEN_ID_GEN2 MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKGEN, 0x3f, 0x3f, 0x3f, 2)
#define CLOCK_MCHP_GCLKGEN_ID_GEN3 MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKGEN, 0x3f, 0x3f, 0x3f, 3)
#define CLOCK_MCHP_GCLKGEN_ID_MAX  (3)
#define GCLK_IO_MAX                CLOCK_MCHP_GCLKGEN_ID_MAX
 
#define CLOCK_MCHP_GCLKPERIPH_ID_EIC MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 0, 0)
#define CLOCK_MCHP_GCLKPERIPH_ID_EVSYS_CHANNEL_0                                                   \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 1, 1)
#define CLOCK_MCHP_GCLKPERIPH_ID_EVSYS_CHANNEL_1                                                   \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 2, 2)
#define CLOCK_MCHP_GCLKPERIPH_ID_EVSYS_CHANNEL_2                                                   \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 3, 3)
#define CLOCK_MCHP_GCLKPERIPH_ID_EVSYS_CHANNEL_3                                                   \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 4, 4)
#define CLOCK_MCHP_GCLKPERIPH_ID_SERCOM0_SLOW                                                      \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 5, 5)
#define CLOCK_MCHP_GCLKPERIPH_ID_SERCOM0_CORE                                                      \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 6, 6)
#define CLOCK_MCHP_GCLKPERIPH_ID_SERCOM1_SLOW                                                      \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 7, 7)
#define CLOCK_MCHP_GCLKPERIPH_ID_SERCOM1_CORE                                                      \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 8, 8)
#define CLOCK_MCHP_GCLKPERIPH_ID_TC0_TC1                                                           \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 9, 9)
#define CLOCK_MCHP_GCLKPERIPH_ID_TC2                                                               \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 10, 10)
#define CLOCK_MCHP_GCLKPERIPH_ID_TCC0                                                              \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 11, 11)
#define CLOCK_MCHP_GCLKPERIPH_ID_CCL                                                               \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_GCLKPERIPH, 0x3f, 0x3f, 12, 12)
#define CLOCK_MCHP_GCLKPERIPH_ID_MAX (12)
 
#define GCLK_PH_MAX CLOCK_MCHP_GCLKPERIPH_ID_MAX
 
#define CLOCK_MCHP_MCLKCPU_ID  MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKCPU, 0x3f, 0x3f, 0x3f, 0)
#define CLOCK_MCHP_MCLKCPU_MAX (0)
 
/* MCLKPERIPH_TYPE ids */
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_APBA                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 0, 0x3f, 0)
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_APBB                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 1, 0x3f, 1)
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_APBC                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 2, 0x3f, 2)
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_DSU                                                           \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 3, 0x3f, 3)
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_HMATRIXHS                                                     \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 4, 0x3f, 4)
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_NVMCTRL                                                       \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 5, 0x3f, 5)
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_HSRAM                                                         \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 6, 0x3f, 6)
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_DMAC                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 7, 0x3f, 7)
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_PAC                                                           \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 8, 0x3f, 8)
#define CLOCK_MCHP_MCLKPERIPH_ID_AHB_BROM                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_AHB, 9, 0x3f, 9)
 
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_PAC                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 0, 0x3f, 10)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_PM                                                           \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 1, 0x3f, 11)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_MCLK                                                         \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 2, 0x3f, 12)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_RSTC                                                         \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 3, 0x3f, 13)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_OSCCTRL                                                      \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 4, 0x3f, 14)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_OSC32KCTRL                                                   \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 5, 0x3f, 15)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_SUPC                                                         \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 6, 0x3f, 16)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_GCLK                                                         \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 7, 0x3f, 17)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_WDT                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 8, 0x3f, 18)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_RTC                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 9, 0x3f, 19)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBA_EIC                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBA, 10, 0x3f, 20)
 
#define CLOCK_MCHP_MCLKPERIPH_ID_APBB_PORT                                                         \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBB, 0, 0x3f, 21)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBB_DSU                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBB, 1, 0x3f, 22)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBB_NVMCTRL                                                      \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBB, 2, 0x3f, 23)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBB_DMAC                                                         \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBB, 3, 0x3f, 24)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBB_MTB                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBB, 4, 0x3f, 25)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBB_HMATRIXHS                                                    \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBB, 5, 0x3f, 26)
 
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_EVSYS                                                        \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 0, 0x3f, 27)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_SERCOM0                                                      \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 1, 0x3f, 28)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_SERCOM1                                                      \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 2, 0x3f, 29)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_TC0                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 3, 0x3f, 30)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_TC1                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 4, 0x3f, 31)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_TC2                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 5, 0x3f, 32)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_TCC0                                                         \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 6, 0x3f, 33)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_ADC0                                                         \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 7, 0x3f, 34)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_AC                                                           \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 8, 0x3f, 35)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_CCL                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 9, 0x3f, 36)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_PTC                                                          \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 10, 0x3f, 37)
#define CLOCK_MCHP_MCLKPERIPH_ID_APBC_SYSCTRL                                                      \
        MCHP_CLOCK_DERIVE_ID(SUBSYS_TYPE_MCLKPERIPH, MBUS_APBC, 11, 0x3f, 38)
#define CLOCK_MCHP_MCLKPERIPH_ID_MAX (38)
 
#endif /* INCLUDE_ZEPHYR_DT_BINDINGS_CLOCK_MCHP_PIC32CM_PL_CLOCK_H_ */