sys/mips/broadcom/bcm_machdep.h

   1 /*-
   2  * Copyright (c) 2016 Landon Fuller <landonf@FreeBSD.org>
   3  * Copyright (c) 2017 The FreeBSD Foundation
   4  * All rights reserved.
   5  *
   6  * Portions of this software were developed by Landon Fuller
   7  * under sponsorship from the FreeBSD Foundation.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer,
  14  *    without modification.
  15  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  16  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  17  *    redistribution must be conditioned upon including a substantially
  18  *    similar Disclaimer requirement for further binary redistribution.
  19  *
  20  * NO WARRANTY
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  24  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  25  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  26  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  29  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  31  * THE POSSIBILITY OF SUCH DAMAGES.
  32  *
  33  * $FreeBSD$
  34  */
  35
  36 #ifndef _MIPS_BROADCOM_BCM_MACHDEP_H_
  37 #define _MIPS_BROADCOM_BCM_MACHDEP_H_
  38
  39 #include <machine/cpufunc.h>
  40 #include <machine/cpuregs.h>
  41
  42 #include <dev/bhnd/bhnd.h>
  43 #include <dev/bhnd/bhnd_eromvar.h>
  44
  45 #include <dev/bhnd/cores/pmu/bhnd_pmuvar.h>
  46
  47 #include "bcm_nvram_cfevar.h"
  48
  49 extern const struct bhnd_pmu_io bcm_pmu_soc_io;
  50
  51 struct bcm_platform {
  52         struct bhnd_chipid               cid;           /**< chip id */
  53         struct bhnd_core_info            cc_id;         /**< chipc core info */
  54         uintptr_t                        cc_addr;       /**< chipc core phys address */
  55         uint32_t                         cc_caps;       /**< chipc capabilities */
  56         uint32_t                         cc_caps_ext;   /**< chipc extended capabilies */
  57
  58         /* On non-AOB devices, the PMU register block is mapped to chipc;
  59          * the pmu_id and pmu_addr values will be copied from cc_id
  60          * and cc_addr. */
  61         struct bhnd_core_info            pmu_id;                /**< PMU core info */
  62         uintptr_t                        pmu_addr;      /**< PMU core phys address, or
  63                                                      0x0 if no PMU */
  64
  65         struct bhnd_pmu_query            pmu;           /**< PMU query instance */
  66
  67         bhnd_erom_class_t               *erom_impl;     /**< erom parser class */
  68         struct kobj_ops                  erom_ops;      /**< compiled kobj opcache */
  69         struct bhnd_erom_iobus           erom_io;       /**< erom I/O callbacks */
  70         union {
  71                 bhnd_erom_static_t       data;
  72                 bhnd_erom_t              obj;
  73         } erom;
  74
  75         struct bhnd_nvram_io            *nvram_io;      /**< NVRAM I/O context, or NULL if unavailable */
  76         bhnd_nvram_data_class           *nvram_cls;     /**< NVRAM data class, or NULL if unavailable */
  77
  78         struct bhnd_service_registry     services;      /**< platform service providers */
  79
  80 #ifdef CFE
  81         int                              cfe_console;   /**< Console handle, or -1 */
  82 #endif
  83 };
  84
  85 struct bcm_platform     *bcm_get_platform(void);
  86
  87 uint64_t                 bcm_get_cpufreq(struct bcm_platform *bp);
  88 uint64_t                 bcm_get_sifreq(struct bcm_platform *bp);
  89 uint64_t                 bcm_get_alpfreq(struct bcm_platform *bp);
  90 uint64_t                 bcm_get_ilpfreq(struct bcm_platform *bp);
  91
  92 u_int                    bcm_get_uart_rclk(struct bcm_platform *bp);
  93
  94 int                      bcm_get_nvram(struct bcm_platform *bp,
  95                              const char *name, void *outp, size_t *olen,
  96                              bhnd_nvram_type type);
  97
  98 #define BCM_ERR(fmt, ...)       \
  99         printf("%s: " fmt, __FUNCTION__, ##__VA_ARGS__)
 100
 101 #define BCM_SOC_BSH(_addr, _offset)                     \
 102         ((bus_space_handle_t)BCM_SOC_ADDR((_addr), (_offset)))
 103
 104 #define BCM_SOC_ADDR(_addr, _offset)                    \
 105         MIPS_PHYS_TO_KSEG1((_addr) + (_offset))
 106
 107 #define BCM_SOC_READ_4(_addr, _offset)                  \
 108         readl(BCM_SOC_ADDR((_addr), (_offset)))
 109 #define BCM_SOC_WRITE_4(_addr, _reg, _val)              \
 110         writel(BCM_SOC_ADDR((_addr), (_offset)), (_val))
 111
 112 #define BCM_CORE_ADDR(_bp, _name, _reg)                 \
 113         BCM_SOC_ADDR(_bp->_name, (_reg))
 114
 115 #define BCM_CORE_READ_4(_bp, _name, _reg)               \
 116         readl(BCM_CORE_ADDR(_bp, _name, (_reg)))
 117 #define BCM_CORE_WRITE_4(_bp, _name, _reg, _val)        \
 118         writel(BCM_CORE_ADDR(_bp, _name, (_reg)), (_val))
 119
 120 #define BCM_CHIPC_READ_4(_bp, _reg)                     \
 121         BCM_CORE_READ_4(_bp, cc_addr, (_reg))
 122 #define BCM_CHIPC_WRITE_4(_bp, _reg, _val)              \
 123         BCM_CORE_WRITE_4(_bp, cc_addr, (_reg), (_val))
 124
 125 #define BCM_PMU_READ_4(_bp, _reg)                       \
 126         BCM_CORE_READ_4(_bp, pmu_addr, (_reg))
 127 #define BCM_PMU_WRITE_4(_bp, _reg, _val)                \
 128         BCM_CORE_WRITE_4(_bp, pmu_addr, (_reg), (_val))
 129
 130 #endif /* _MIPS_BROADCOM_BCM_MACHDEP_H_ */