root/arch/arm/mach-omap2/soc.h
/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * OMAP cpu type detection
 *
 * Copyright (C) 2004, 2008 Nokia Corporation
 *
 * Copyright (C) 2009-11 Texas Instruments.
 *
 * Written by Tony Lindgren <tony.lindgren@nokia.com>
 *
 * Added OMAP4/5 specific defines - Santosh Shilimkar<santosh.shilimkar@ti.com>
 * Added DRA7xxx specific defines - Sricharan R<r.sricharan@ti.com>
 */

#include "omap24xx.h"
#include "omap34xx.h"
#include "omap44xx.h"
#include "ti81xx.h"
#include "am33xx.h"
#include "omap54xx.h"

#ifndef __ASSEMBLY__

#include <linux/bitops.h>
#include <linux/of.h>

/*
 * OMAP2+ is always defined as ARCH_MULTIPLATFORM in Kconfig
 */
#undef MULTI_OMAP2
#define MULTI_OMAP2

/*
 * Omap device type i.e. EMU/HS/TST/GP/BAD
 */
#define OMAP2_DEVICE_TYPE_TEST          0
#define OMAP2_DEVICE_TYPE_EMU           1
#define OMAP2_DEVICE_TYPE_SEC           2
#define OMAP2_DEVICE_TYPE_GP            3
#define OMAP2_DEVICE_TYPE_BAD           4

int omap_type(void);

/*
 * omap_rev bits:
 * SoC id bits  (0730, 1510, 1710, 2422...)     [31:16]
 * SoC revision (See _REV_ defined in cpu.h)    [15:08]
 * SoC class bits (15xx, 16xx, 24xx, 34xx...)   [07:00]
 */
unsigned int omap_rev(void);

static inline int soc_is_omap(void)
{
        return omap_rev() != 0;
}

/*
 * Get the SoC revision for OMAP devices
 */
#define GET_OMAP_REVISION()     ((omap_rev() >> 8) & 0xff)

/*
 * Macros to group OMAP into cpu classes.
 * These can be used in most places.
 * soc_is_omap24xx():   True for OMAP2420, OMAP2422, OMAP2423, OMAP2430
 * soc_is_omap242x():   True for OMAP2420, OMAP2422, OMAP2423
 * soc_is_omap243x():   True for OMAP2430
 * soc_is_omap343x():   True for OMAP3430
 * soc_is_omap443x():   True for OMAP4430
 * soc_is_omap446x():   True for OMAP4460
 * soc_is_omap447x():   True for OMAP4470
 * soc_is_omap543x():   True for OMAP5430, OMAP5432
 */
#define GET_OMAP_CLASS  (omap_rev() & 0xff)

#define IS_OMAP_CLASS(class, id)                        \
static inline int is_omap ##class (void)                \
{                                                       \
        return (GET_OMAP_CLASS == (id)) ? 1 : 0;        \
}

#define GET_AM_CLASS    ((omap_rev() >> 24) & 0xff)

#define IS_AM_CLASS(class, id)                          \
static inline int is_am ##class (void)                  \
{                                                       \
        return (GET_AM_CLASS == (id)) ? 1 : 0;          \
}

#define GET_TI_CLASS    ((omap_rev() >> 24) & 0xff)

#define IS_TI_CLASS(class, id)                  \
static inline int is_ti ##class (void)          \
{                                                       \
        return (GET_TI_CLASS == (id)) ? 1 : 0;  \
}

#define GET_DRA_CLASS   ((omap_rev() >> 24) & 0xff)

#define IS_DRA_CLASS(class, id)                         \
static inline int is_dra ##class (void)                 \
{                                                       \
        return (GET_DRA_CLASS == (id)) ? 1 : 0;         \
}

#define GET_OMAP_SUBCLASS       ((omap_rev() >> 20) & 0x0fff)

#define IS_OMAP_SUBCLASS(subclass, id)                  \
static inline int is_omap ##subclass (void)             \
{                                                       \
        return (GET_OMAP_SUBCLASS == (id)) ? 1 : 0;     \
}

#define IS_TI_SUBCLASS(subclass, id)                    \
static inline int is_ti ##subclass (void)               \
{                                                       \
        return (GET_OMAP_SUBCLASS == (id)) ? 1 : 0;     \
}

#define IS_AM_SUBCLASS(subclass, id)                    \
static inline int is_am ##subclass (void)               \
{                                                       \
        return (GET_OMAP_SUBCLASS == (id)) ? 1 : 0;     \
}

#define IS_DRA_SUBCLASS(subclass, id)                   \
static inline int is_dra ##subclass (void)              \
{                                                       \
        return (GET_OMAP_SUBCLASS == (id)) ? 1 : 0;     \
}

#define GET_DRA_PACKAGE         (omap_rev() & 0xff)

#define IS_DRA_SUBCLASS_PACKAGE(subclass, package, id)                  \
static inline int is_dra ##subclass ##_ ##package (void)                \
{                                                                       \
        return (is_dra ##subclass () && GET_DRA_PACKAGE == id) ? 1 : 0; \
}

IS_OMAP_CLASS(24xx, 0x24)
IS_OMAP_CLASS(34xx, 0x34)
IS_OMAP_CLASS(44xx, 0x44)
IS_AM_CLASS(35xx, 0x35)
IS_OMAP_CLASS(54xx, 0x54)
IS_AM_CLASS(33xx, 0x33)
IS_AM_CLASS(43xx, 0x43)

IS_TI_CLASS(81xx, 0x81)
IS_DRA_CLASS(7xx, 0x7)

IS_OMAP_SUBCLASS(242x, 0x242)
IS_OMAP_SUBCLASS(243x, 0x243)
IS_OMAP_SUBCLASS(343x, 0x343)
IS_OMAP_SUBCLASS(363x, 0x363)
IS_OMAP_SUBCLASS(443x, 0x443)
IS_OMAP_SUBCLASS(446x, 0x446)
IS_OMAP_SUBCLASS(447x, 0x447)
IS_OMAP_SUBCLASS(543x, 0x543)

IS_TI_SUBCLASS(816x, 0x816)
IS_TI_SUBCLASS(814x, 0x814)
IS_AM_SUBCLASS(335x, 0x335)
IS_AM_SUBCLASS(437x, 0x437)
IS_DRA_SUBCLASS(76x, 0x76)
IS_DRA_SUBCLASS_PACKAGE(76x, abz, 2)
IS_DRA_SUBCLASS_PACKAGE(76x, acd, 3)
IS_DRA_SUBCLASS(75x, 0x75)
IS_DRA_SUBCLASS(72x, 0x72)

#define soc_is_ti81xx()                 0
#define soc_is_ti816x()                 0
#define soc_is_ti814x()                 0
#define soc_is_am35xx()                 0
#define soc_is_am33xx()                 0
#define soc_is_am335x()                 0
#define soc_is_am43xx()                 0
#define soc_is_am437x()                 0
#define soc_is_omap44xx()               0
#define soc_is_omap443x()               0
#define soc_is_omap446x()               0
#define soc_is_omap447x()               0
#define soc_is_omap54xx()               0
#define soc_is_omap543x()               0
#define soc_is_dra7xx()                 0
#define soc_is_dra76x()                 0
#define soc_is_dra74x()                 0
#define soc_is_dra72x()                 0

#if defined(CONFIG_ARCH_OMAP2)
# define soc_is_omap24xx()              is_omap24xx()
#else
# define soc_is_omap24xx()              0
#endif
#if defined(CONFIG_SOC_OMAP2420)
# define soc_is_omap242x()              is_omap242x()
#else
# define soc_is_omap242x()              0
#endif
#if defined(CONFIG_SOC_OMAP2430)
# define soc_is_omap243x()              is_omap243x()
#else
# define soc_is_omap243x()              0
#endif
#if defined(CONFIG_ARCH_OMAP3)
# define soc_is_omap34xx()              is_omap34xx()
# define soc_is_omap343x()              is_omap343x()
#else
# define soc_is_omap34xx()              0
# define soc_is_omap343x()              0
#endif

/*
 * Macros to detect individual cpu types.
 * These are only rarely needed.
 * soc_is_omap2420():   True for OMAP2420
 * soc_is_omap2422():   True for OMAP2422
 * soc_is_omap2423():   True for OMAP2423
 * soc_is_omap2430():   True for OMAP2430
 * soc_is_omap3430():   True for OMAP3430
 */
#define GET_OMAP_TYPE   ((omap_rev() >> 16) & 0xffff)

#define IS_OMAP_TYPE(type, id)                          \
static inline int is_omap ##type (void)                 \
{                                                       \
        return (GET_OMAP_TYPE == (id)) ? 1 : 0;         \
}

IS_OMAP_TYPE(2420, 0x2420)
IS_OMAP_TYPE(2422, 0x2422)
IS_OMAP_TYPE(2423, 0x2423)
IS_OMAP_TYPE(2430, 0x2430)
IS_OMAP_TYPE(3430, 0x3430)

#define soc_is_omap2420()               0
#define soc_is_omap2422()               0
#define soc_is_omap2423()               0
#define soc_is_omap2430()               0
#define soc_is_omap3430()               0
#define soc_is_omap3630()               0
#define soc_is_omap5430()               0

/* These are needed for the common code */
#define soc_is_omap7xx()                0
#define soc_is_omap15xx()               0
#define soc_is_omap16xx()               0
#define soc_is_omap1510()               0
#define soc_is_omap1610()               0
#define soc_is_omap1611()               0
#define soc_is_omap1621()               0
#define soc_is_omap1710()               0
#define cpu_class_is_omap1()            0
#define cpu_class_is_omap2()            1

#if defined(CONFIG_ARCH_OMAP2)
# undef  soc_is_omap2420
# undef  soc_is_omap2422
# undef  soc_is_omap2423
# undef  soc_is_omap2430
# define soc_is_omap2420()              is_omap2420()
# define soc_is_omap2422()              is_omap2422()
# define soc_is_omap2423()              is_omap2423()
# define soc_is_omap2430()              is_omap2430()
#endif

#if defined(CONFIG_ARCH_OMAP3)
# undef soc_is_omap3430
# undef soc_is_ti81xx
# undef soc_is_ti816x
# undef soc_is_ti814x
# undef soc_is_am35xx
# define soc_is_omap3430()              is_omap3430()
# undef soc_is_omap3630
# define soc_is_omap3630()              is_omap363x()
# define soc_is_ti81xx()                is_ti81xx()
# define soc_is_ti816x()                is_ti816x()
# define soc_is_ti814x()                is_ti814x()
# define soc_is_am35xx()                is_am35xx()
#endif

# if defined(CONFIG_SOC_AM33XX)
# undef soc_is_am33xx
# undef soc_is_am335x
# define soc_is_am33xx()                is_am33xx()
# define soc_is_am335x()                is_am335x()
#endif

#ifdef  CONFIG_SOC_AM43XX
# undef soc_is_am43xx
# undef soc_is_am437x
# define soc_is_am43xx()                is_am43xx()
# define soc_is_am437x()                is_am437x()
#endif

# if defined(CONFIG_ARCH_OMAP4)
# undef soc_is_omap44xx
# undef soc_is_omap443x
# undef soc_is_omap446x
# undef soc_is_omap447x
# define soc_is_omap44xx()              is_omap44xx()
# define soc_is_omap443x()              is_omap443x()
# define soc_is_omap446x()              is_omap446x()
# define soc_is_omap447x()              is_omap447x()
# endif

# if defined(CONFIG_SOC_OMAP5)
# undef soc_is_omap54xx
# undef soc_is_omap543x
# define soc_is_omap54xx()              is_omap54xx()
# define soc_is_omap543x()              is_omap543x()
#endif

#if defined(CONFIG_SOC_DRA7XX)
#undef soc_is_dra7xx
#undef soc_is_dra76x
#undef soc_is_dra76x_abz
#undef soc_is_dra76x_acd
#undef soc_is_dra74x
#undef soc_is_dra72x
#define soc_is_dra7xx() is_dra7xx()
#define soc_is_dra76x() is_dra76x()
#define soc_is_dra76x_abz()     is_dra76x_abz()
#define soc_is_dra76x_acd()     is_dra76x_acd()
#define soc_is_dra74x() is_dra75x()
#define soc_is_dra72x() is_dra72x()
#endif

/* Various silicon revisions for omap2 */
#define OMAP242X_CLASS          0x24200024
#define OMAP2420_REV_ES1_0      OMAP242X_CLASS
#define OMAP2420_REV_ES2_0      (OMAP242X_CLASS | (0x1 << 8))

#define OMAP243X_CLASS          0x24300024
#define OMAP2430_REV_ES1_0      OMAP243X_CLASS

#define OMAP343X_CLASS          0x34300034
#define OMAP3430_REV_ES1_0      OMAP343X_CLASS
#define OMAP3430_REV_ES2_0      (OMAP343X_CLASS | (0x1 << 8))
#define OMAP3430_REV_ES2_1      (OMAP343X_CLASS | (0x2 << 8))
#define OMAP3430_REV_ES3_0      (OMAP343X_CLASS | (0x3 << 8))
#define OMAP3430_REV_ES3_1      (OMAP343X_CLASS | (0x4 << 8))
#define OMAP3430_REV_ES3_1_2    (OMAP343X_CLASS | (0x5 << 8))

#define OMAP363X_CLASS          0x36300034
#define OMAP3630_REV_ES1_0      OMAP363X_CLASS
#define OMAP3630_REV_ES1_1      (OMAP363X_CLASS | (0x1 << 8))
#define OMAP3630_REV_ES1_2      (OMAP363X_CLASS | (0x2 << 8))

#define TI816X_CLASS            0x81600081
#define TI8168_REV_ES1_0        TI816X_CLASS
#define TI8168_REV_ES1_1        (TI816X_CLASS | (0x1 << 8))
#define TI8168_REV_ES2_0        (TI816X_CLASS | (0x2 << 8))
#define TI8168_REV_ES2_1        (TI816X_CLASS | (0x3 << 8))

#define TI814X_CLASS            0x81400081
#define TI8148_REV_ES1_0        TI814X_CLASS
#define TI8148_REV_ES2_0        (TI814X_CLASS | (0x1 << 8))
#define TI8148_REV_ES2_1        (TI814X_CLASS | (0x2 << 8))

#define AM35XX_CLASS            0x35170034
#define AM35XX_REV_ES1_0        AM35XX_CLASS
#define AM35XX_REV_ES1_1        (AM35XX_CLASS | (0x1 << 8))

#define AM335X_CLASS            0x33500033
#define AM335X_REV_ES1_0        AM335X_CLASS
#define AM335X_REV_ES2_0        (AM335X_CLASS | (0x1 << 8))
#define AM335X_REV_ES2_1        (AM335X_CLASS | (0x2 << 8))

#define AM437X_CLASS            0x43700000
#define AM437X_REV_ES1_0        (AM437X_CLASS | (0x10 << 8))
#define AM437X_REV_ES1_1        (AM437X_CLASS | (0x11 << 8))
#define AM437X_REV_ES1_2        (AM437X_CLASS | (0x12 << 8))

#define OMAP443X_CLASS          0x44300044
#define OMAP4430_REV_ES1_0      (OMAP443X_CLASS | (0x10 << 8))
#define OMAP4430_REV_ES2_0      (OMAP443X_CLASS | (0x20 << 8))
#define OMAP4430_REV_ES2_1      (OMAP443X_CLASS | (0x21 << 8))
#define OMAP4430_REV_ES2_2      (OMAP443X_CLASS | (0x22 << 8))
#define OMAP4430_REV_ES2_3      (OMAP443X_CLASS | (0x23 << 8))

#define OMAP446X_CLASS          0x44600044
#define OMAP4460_REV_ES1_0      (OMAP446X_CLASS | (0x10 << 8))
#define OMAP4460_REV_ES1_1      (OMAP446X_CLASS | (0x11 << 8))

#define OMAP447X_CLASS          0x44700044
#define OMAP4470_REV_ES1_0      (OMAP447X_CLASS | (0x10 << 8))

#define OMAP54XX_CLASS          0x54000054
#define OMAP5430_REV_ES2_0      (OMAP54XX_CLASS | (0x30 << 16) | (0x20 << 8))
#define OMAP5432_REV_ES2_0      (OMAP54XX_CLASS | (0x32 << 16) | (0x20 << 8))

#define DRA7XX_CLASS            0x07000000
#define DRA762_REV_ES1_0        (DRA7XX_CLASS | (0x62 << 16) | (0x10 << 8))
#define DRA762_ABZ_REV_ES1_0    (DRA762_REV_ES1_0 | (2 << 0))
#define DRA762_ACD_REV_ES1_0    (DRA762_REV_ES1_0 | (3 << 0))
#define DRA752_REV_ES1_0        (DRA7XX_CLASS | (0x52 << 16) | (0x10 << 8))
#define DRA752_REV_ES1_1        (DRA7XX_CLASS | (0x52 << 16) | (0x11 << 8))
#define DRA752_REV_ES2_0        (DRA7XX_CLASS | (0x52 << 16) | (0x20 << 8))
#define DRA722_REV_ES1_0        (DRA7XX_CLASS | (0x22 << 16) | (0x10 << 8))
#define DRA722_REV_ES2_0        (DRA7XX_CLASS | (0x22 << 16) | (0x20 << 8))
#define DRA722_REV_ES2_1        (DRA7XX_CLASS | (0x22 << 16) | (0x21 << 8))

void omap2xxx_check_revision(void);
void omap3xxx_check_revision(void);
void omap4xxx_check_revision(void);
void omap5xxx_check_revision(void);
void dra7xxx_check_revision(void);
void omap3xxx_check_features(void);
void ti81xx_check_features(void);
void am33xx_check_features(void);
void omap4xxx_check_features(void);

/*
 * Runtime detection of OMAP3 features
 *
 * OMAP3_HAS_IO_CHAIN_CTRL: Some later members of the OMAP3 chip
 *    family have OS-level control over the I/O chain clock.  This is
 *    to avoid a window during which wakeups could potentially be lost
 *    during powerdomain transitions.  If this bit is set, it
 *    indicates that the chip does support OS-level control of this
 *    feature.
 */
extern u32 omap_features;

#define OMAP3_HAS_L2CACHE               BIT(0)
#define OMAP3_HAS_IVA                   BIT(1)
#define OMAP3_HAS_SGX                   BIT(2)
#define OMAP3_HAS_NEON                  BIT(3)
#define OMAP3_HAS_ISP                   BIT(4)
#define OMAP3_HAS_192MHZ_CLK            BIT(5)
#define OMAP3_HAS_IO_WAKEUP             BIT(6)
#define OMAP3_HAS_SDRC                  BIT(7)
#define OMAP3_HAS_IO_CHAIN_CTRL         BIT(8)
#define OMAP4_HAS_PERF_SILICON          BIT(9)


#define OMAP3_HAS_FEATURE(feat,flag)                    \
static inline unsigned int omap3_has_ ##feat(void)      \
{                                                       \
        return omap_features & OMAP3_HAS_ ##flag;       \
}                                                       \

OMAP3_HAS_FEATURE(l2cache, L2CACHE)
OMAP3_HAS_FEATURE(sgx, SGX)
OMAP3_HAS_FEATURE(iva, IVA)
OMAP3_HAS_FEATURE(neon, NEON)
OMAP3_HAS_FEATURE(isp, ISP)
OMAP3_HAS_FEATURE(192mhz_clk, 192MHZ_CLK)
OMAP3_HAS_FEATURE(io_wakeup, IO_WAKEUP)
OMAP3_HAS_FEATURE(sdrc, SDRC)
OMAP3_HAS_FEATURE(io_chain_ctrl, IO_CHAIN_CTRL)

/*
 * Runtime detection of OMAP4 features
 */
#define OMAP4_HAS_FEATURE(feat, flag)                   \
static inline unsigned int omap4_has_ ##feat(void)      \
{                                                       \
        return omap_features & OMAP4_HAS_ ##flag;       \
}                                                       \

OMAP4_HAS_FEATURE(perf_silicon, PERF_SILICON)

/*
 * We need to make sure omap initcalls don't run when
 * multiplatform kernels are booted on other SoCs.
 */
#define omap_initcall(level, fn)                \
static int __init __used __##fn(void)           \
{                                               \
        if (!soc_is_omap())                     \
                return 0;                       \
        return fn();                            \
}                                               \
level(__##fn);

#define omap_early_initcall(fn)         omap_initcall(early_initcall, fn)
#define omap_core_initcall(fn)          omap_initcall(core_initcall, fn)
#define omap_postcore_initcall(fn)      omap_initcall(postcore_initcall, fn)
#define omap_arch_initcall(fn)          omap_initcall(arch_initcall, fn)
#define omap_subsys_initcall(fn)        omap_initcall(subsys_initcall, fn)
#define omap_device_initcall(fn)        omap_initcall(device_initcall, fn)
#define omap_late_initcall(fn)          omap_initcall(late_initcall, fn)
#define omap_late_initcall_sync(fn)     omap_initcall(late_initcall_sync, fn)

/* Legacy defines, these can be removed when users are removed */
#define cpu_is_omap2420()       soc_is_omap2420()
#define cpu_is_omap2422()       soc_is_omap2422()
#define cpu_is_omap242x()       soc_is_omap242x()
#define cpu_is_omap2430()       soc_is_omap2430()
#define cpu_is_omap243x()       soc_is_omap243x()
#define cpu_is_omap24xx()       soc_is_omap24xx()
#define cpu_is_omap3430()       soc_is_omap3430()
#define cpu_is_omap343x()       soc_is_omap343x()
#define cpu_is_omap34xx()       soc_is_omap34xx()
#define cpu_is_omap3630()       soc_is_omap3630()
#define cpu_is_omap443x()       soc_is_omap443x()
#define cpu_is_omap446x()       soc_is_omap446x()
#define cpu_is_omap44xx()       soc_is_omap44xx()
#define cpu_is_ti814x()         soc_is_ti814x()
#define cpu_is_ti816x()         soc_is_ti816x()
#define cpu_is_ti81xx()         soc_is_ti81xx()

#endif  /* __ASSEMBLY__ */