summaryrefslogblamecommitdiffstats
path: root/rtemsbsd/include/machine/rtems-bsd-nexus-bus.h
blob: 5a3458c64dfd81c01f23ae647d81537359e34a37 (plain) (tree)



































































































                                                                             














                                                                         








                                               




                                                           








                                          















                                                                  




                                     



                                                                   




                                     


                                                   




                                 



                                                   




                                 


                                                   








                                      















                                                                  




                                                  


                                                           


                                 
                                                  
   



















                                                                             
                                               



                                                          



                                               















                                                                  




                                  























                                                                     




                                  


                                                   




                                     


                                                   




                                     


                                                   




                                    


                                                   








                                    


                                                   




                                      


                                                   




                                   


                                                   






                                   
/*
 * Copyright (c) 2013-2015 embedded brains GmbH.  All rights reserved.
 *
 *  embedded brains GmbH
 *  Dornierstr. 4
 *  82178 Puchheim
 *  Germany
 *  <rtems@embedded-brains.de>
 *
 * Copyright (c) 2016 Chris Johns <chrisj@rtems.org> All rights reserved.

 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/*
 * The Nexus bus devices.
 *
 * Driver Summary is:
 *
 *  Devices:
 *   RTEMS_BSD_DRIVER_XILINX_ZYNQ_SLCR0
 *
 *  Buses:
 *   RTEMS_BSD_DRIVER_PC_LEGACY
 *
 *  USB:
 *   RTEMS_BSD_DRIVER_DWCOTG0
 *   RTEMS_BSD_DRIVER_DWCOTG0_BASE_ADDR
 *    RTEMS_BSD_DRIVER_DWCOTG0_IRQ
 *   RTEMS_BSD_DRIVER_DWC_MMC
 *   RTEMS_BSD_DRIVER_MMC
 *   RTEMS_BSD_DRIVER_USB
 *   RTEMS_BSD_DRIVER_USB_MASS
 *
 *  Networking:
 *   RTEMS_BSD_DRIVER_SMC0
 *    RTEMS_BSD_DRIVER_SMC0_BASE_ADDR
 *    RTEMS_BSD_DRIVER_SMC0_IRQ
 *   RTEMS_BSD_DRIVER_FEC
 *   RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM0
 *    RTEMS_BSD_DRIVER_CGEM0_IRQ
 *   RTEMS_BSD_DRIVER_DWC0
 *    RTEMS_BSD_DRIVER_DWC0_BASE_ADDR
 *    RTEMS_BSD_DRIVER_DWC0_IRQ
 *   RTEMS_BSD_DRIVER_TSEC
 *    RTEMS_BSD_DRIVER_TSEC_BASE_ADDR
 *    RTEMS_BSD_DRIVER_TSEC_TX_IRQ
 *    RTEMS_BSD_DRIVER_TSEC_RX_IRQ
 *    RTEMS_BSD_DRIVER_TSEC_ER_IRQ
 *   RTEMS_BSD_DRIVER_PCI_LEM
 *   RTEMS_BSD_DRIVER_PCI_IGB
 *   RTEMS_BSD_DRIVER_PCI_EM
 *   RTEMS_BSD_DRIVER_PCI_RE
 *
 *  MMI PHY:
 *   RTEMS_BSD_DRIVER_E1000PHY
 *   RTEMS_BSD_DRIVER_REPHY
 *   RTEMS_BSD_DRIVER_MIPHY
 */

#if !defined(RTEMS_BSD_NEXUS_BUS_h)
#define RTEMS_BSD_NEXUS_BUS_h

#include <rtems/bsd/bsd.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/**
 * Keep the order of the groups.
 **/

/**
 ** Devices
 **
 **/

/*
 * Xilinx Zynq System Level Control Core 0 (SLCR0).
 */
#if !defined(RTEMS_BSD_DRIVER_XILINX_ZYNQ_SLCR)
  /*
   * Hard IP part of the Zynq so a fixed address.
   */
  #define RTEMS_BSD_DRIVER_XILINX_ZYNQ_SLCR0                            \
    static const rtems_bsd_device_resource zy7_slcr0_res[] = {          \
      {                                                                 \
        .type = RTEMS_BSD_RES_MEMORY,                                   \
        .start_request = 0,                                             \
        .start_actual = 0xf8000000                                      \
      }                                                                 \
    };                                                                  \
    RTEMS_BSD_DEFINE_NEXUS_DEVICE(zy7_slcr, 0,                          \
                                  RTEMS_ARRAY_SIZE(zy7_slcr0_res),      \
                                  &zy7_slcr0_res[0])
#endif /* RTEMS_BSD_DRIVER_XILINX_ZYNQ_SLCR0 */

/**
 ** Physical Buses
 **/

/*
 * PC legacy bus.
 */
#if !defined(RTEMS_BSD_DRIVER_PC_LEGACY)
  #define RTEMS_BSD_DRIVER_PC_LEGACY                      \
    RTEMS_BSD_DEFINE_NEXUS_DEVICE(legacy, 0, 0, NULL);    \
    SYSINIT_DRIVER_REFERENCE(pcib, legacy);               \
    SYSINIT_DRIVER_REFERENCE(pci, pcib)
#endif /* RTEMS_BSD_DRIVER_PC_LEGACY */

/**
 ** USB
 **/

/*
 * Designware/Synopsys OTG USB Controller.
 */
#if !defined(RTEMS_BSD_DRIVER_DWCOTG0)
  #define RTEMS_BSD_DRIVER_DWCOTG0(_base, _irq)                  \
    static const rtems_bsd_device_resource dwcotg0_res[] = {     \
      {                                                          \
        .type = RTEMS_BSD_RES_MEMORY,                            \
        .start_request = 0,                                      \
        .start_actual = (_base)                                  \
      }, {                                                       \
        .type = RTEMS_BSD_RES_IRQ,                               \
        .start_request = 0,                                      \
        .start_actual = (_irq)                                   \
      }                                                          \
    };                                                           \
    RTEMS_BSD_DEFINE_NEXUS_DEVICE(dwcotg, 0,                     \
                                  RTEMS_ARRAY_SIZE(dwcotg0_res), \
                                  &dwcotg0_res[0])
#endif /* RTEMS_BSD_DRIVER_DWCOTG0 */

/*
 * Designware/Synopsys MMC.
 */
#if !defined(RTEMS_BSD_DRIVER_DWC_MMC)
  #define RTEMS_BSD_DRIVER_DWC_MMC                                \
    RTEMS_BSD_DEFINE_NEXUS_DEVICE(dw_mmc, 0, 0, NULL);            \
    SYSINIT_DRIVER_REFERENCE(mmc, dw_mmc)
#endif /* RTEMS_BSD_DRIVER_DWC_MMC */

/*
 * MMC Driver.
 */
#if !defined(RTEMS_BSD_DRIVER_MMC)
  #define RTEMS_BSD_DRIVER_MMC                    \
    SYSINIT_DRIVER_REFERENCE(mmcsd, mmc)
#endif /* RTEMS_BSD_DRIVER_MMC */

/*
 * USB Drivers.
 */
#if !defined(RTEMS_BSD_DRIVER_USB)
  #define RTEMS_BSD_DRIVER_USB                    \
    SYSINIT_REFERENCE(usb_quirk_init);            \
    SYSINIT_DRIVER_REFERENCE(uhub, usbus)
#endif /* RTEMS_BSD_DRIVER_USB */

/*
 * USB Mass Storage Class driver.
 */
#if !defined(RTEMS_BSD_DRIVER_USB_MASS)
  #define RTEMS_BSD_DRIVER_USB_MASS               \
    SYSINIT_DRIVER_REFERENCE(umass, uhub)
#endif /* RTEMS_BSD_DRIVER_USB_MASS */

/**
 ** Networking
 **/

/*
 * SMC0 driver
 */
#if !defined(RTEMS_BSD_DRIVER_SMC0)
  #define RTEMS_BSD_DRIVER_SMC0(_base, _irq)                     \
    static const rtems_bsd_device_resource smc0_res[] = {        \
      {                                                          \
        .type = RTEMS_BSD_RES_MEMORY,                            \
        .start_request = 0,                                      \
        .start_actual = (_base)                                  \
      }, {                                                       \
        .type = RTEMS_BSD_RES_IRQ,                               \
        .start_request = 0,                                      \
        .start_actual = (_irq)                                   \
      }                                                          \
    };                                                           \
    RTEMS_BSD_DEFINE_NEXUS_DEVICE(smc, 0,                        \
                                  RTEMS_ARRAY_SIZE(smc0_res),    \
                                  &smc0_res[0])
#endif /* RTEMS_BSD_DRIVER_SMC */

/*
 * Coldfire Fast Ethernet Controller (FEC) driver.
 */
#if !defined(RTEMS_BSD_DRIVER_FEC)
  #define RTEMS_BSD_DRIVER_FEC                            \
    RTEMS_BSD_DEFINE_NEXUS_DEVICE(fec, 0, 0, NULL);
#endif /* RTEMS_BSD_DRIVER_FEC */

/*
 * Xilinx Zynq Cadence Gigbit Ethernet MAC (CGEM).
 */
#if !defined(RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM)
  #define RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM(_num, _base, _irq)              \
    static const rtems_bsd_device_resource cgem ## _num ## _res[] = {       \
      {                                                                     \
        .type = RTEMS_BSD_RES_MEMORY,                                       \
        .start_request = 0,                                                 \
        .start_actual = (_base)                                             \
      }, {                                                                  \
        .type = RTEMS_BSD_RES_IRQ,                                          \
        .start_request = 0,                                                 \
        .start_actual = (_irq)                                              \
      }                                                                     \
    };                                                                      \
    RTEMS_BSD_DEFINE_NEXUS_DEVICE(cgem, _num,                               \
                                  RTEMS_ARRAY_SIZE(cgem ## _num ## _res),   \
                                  &cgem ## _num ## _res[0])
#endif /* RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM */
#if !defined(RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM0)
  #define RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM0(_irq)                \
    RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM(0, 0xe000b000, _irq)
#endif /* RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM0 */
#if !defined(RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM1)
  #define RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM1(_irq)       \
    RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM(1, 0xe000c000, _irq)
#endif /* RTEMS_BSD_DRIVER_XILINX_ZYNQ_CGEM1 */

/*
 * Designware/Synopsys Ethernet MAC Controller.
 */
#if !defined(RTEMS_BSD_DRIVER_DWC0)
  #define RTEMS_BSD_DRIVER_DWC0(_base, _irq)                     \
    static const rtems_bsd_device_resource dwc0_res[] = {        \
      {                                                          \
        .type = RTEMS_BSD_RES_MEMORY,                            \
        .start_request = 0,                                      \
        .start_actual = (_base)                                  \
      }, {                                                       \
        .type = RTEMS_BSD_RES_IRQ,                               \
        .start_request = 0,                                      \
        .start_actual = (_irq)                                   \
      }                                                          \
    };                                                           \
    RTEMS_BSD_DEFINE_NEXUS_DEVICE(dwc, 0,                        \
                                  RTEMS_ARRAY_SIZE(dwc0_res),    \
                                  &dwc0_res[0])
#endif /* RTEMS_BSD_DRIVER_DWC0 */

/*
 * NXP QorIQ Network Driver.
 */
#if !defined(RTEMS_BSD_DRIVER_TSEC)
  #define RTEMS_BSD_DRIVER_TSEC(_base, _tx_irq, _rx_irq, _er_irq)   \
    static const rtems_bsd_device_resource tsec0_res[] = {          \
      {                                                             \
        .type = RTEMS_BSD_RES_MEMORY,                               \
        .start_request = 0,                                         \
        .start_actual = (_base)                                     \
      }, {                                                          \
        .type = RTEMS_BSD_RES_IRQ,                                  \
        .start_request = 0,                                         \
        .start_actual = (_tx_irq)                                   \
      }, {                                                          \
        .type = RTEMS_BSD_RES_IRQ,                                  \
        .start_request = 1,                                         \
        .start_actual = (_rx_irq)                                   \
      }, {                                                          \
        .type = RTEMS_BSD_RES_IRQ,                                  \
        .start_request = 2,                                         \
        .start_actual = (_er_irq)                                   \
      }                                                             \
    };                                                              \
    RTEMS_BSD_DEFINE_NEXUS_DEVICE(tsec, 0,                          \
                                  RTEMS_ARRAY_SIZE(tsec0_res),      \
                                  &tsec0_res[0])
#endif /* RTEMS_BSD_DRIVER_TSEC */

/*
 * Intel's Legacy EM driver.
 */
#if !defined(RTEMS_BSD_DRIVER_PCI_LEM)
  #define RTEMS_BSD_DRIVER_PCI_LEM                \
    SYSINIT_DRIVER_REFERENCE(lem, pci);
#endif /* RTEMS_BSD_DRIVER_PCI_LEM */

/*
 * Intel's Gigabit Driver.
 */
#if !defined(RTEMS_BSD_DRIVER_PCI_IGB)
  #define RTEMS_BSD_DRIVER_PCI_IGB                \
    SYSINIT_DRIVER_REFERENCE(igb, pci);
#endif /* RTEMS_BSD_DRIVER_PCI_IGB */

/*
 * Intel's EM Driver.
 */
#if !defined(RTEMS_BSD_DRIVER_PCI_EM)
  #define RTEMS_BSD_DRIVER_PCI_EM                 \
    SYSINIT_DRIVER_REFERENCE(em, pci);
#endif /* RTEMS_BSD_DRIVER_PCI_EM */

/*
 * Realtek Driver
 */
#if !defined(RTEMS_BSD_DRIVER_PCI_RE)
  #define RTEMS_BSD_DRIVER_PCI_RE                 \
    SYSINIT_DRIVER_REFERENCE(re, pci);
#endif /* RTEMS_BSD_DRIVER_PCI_RE */

/**
 ** MMI Physical Layer Support.
 **/

/*
 * E1000 PHY
 */
#if !defined(RTEMS_BSD_DRIVER_E1000PHY)
  #define RTEMS_BSD_DRIVER_E1000PHY               \
    SYSINIT_DRIVER_REFERENCE(e1000phy, miibus);
#endif /* RTEMS_BSD_DRIVER_E1000PHY */

/*
 * Reltek PHY
 */
#if !defined(RTEMS_BSD_DRIVER_REPHY)
  #define RTEMS_BSD_DRIVER_REPHY                  \
    SYSINIT_DRIVER_REFERENCE(rgephy, miibus);
#endif /* RTEMS_BSD_DRIVER_REPHY */

/*
 * MI PHY.
 */
#if !defined(RTEMS_BSD_DRIVER_MIPHY)
  #define RTEMS_BSD_DRIVER_MIPHY                  \
    SYSINIT_DRIVER_REFERENCE(micphy, miibus);
#endif /* RTEMS_BSD_DRIVER_MIPHY */

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif