path: root/bsps/include/dev/grlib/spwpnp.h

/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSDeviceGRLIB
 *
 * @brief This header file defines the SPWPNP register block interface.
 */

/*
 * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 *
 * 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 COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

/* Generated from spec:/dev/grlib/if/spwpnp-header */

#ifndef _DEV_GRLIB_SPWPNP_H
#define _DEV_GRLIB_SPWPNP_H

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/dev/grlib/if/spwpnp */

/**
 * @defgroup DevGrlibIfSpwpnp SpaceWire Plug-and-Play
 *
 * @ingroup RTEMSDeviceGRLIB
 *
 * @brief This group contains the SpaceWire Plug-and-Play interfaces.
 *
 * @{
 */

/**
 * @defgroup DevGrlibIfSpwpnpPNPVEND PNPVEND
 *
 * @brief SpaceWire Plug-and-Play - Device Vendor and Product ID
 *
 * @{
 */

#define SPWPNP_PNPVEND_VEND_SHIFT 16
#define SPWPNP_PNPVEND_VEND_MASK 0xffff0000U
#define SPWPNP_PNPVEND_VEND_GET( _reg ) \
  ( ( ( _reg ) >> 16 ) & 0xffffU )
#define SPWPNP_PNPVEND_VEND( _val ) ( ( _val ) << 16 )

#define SPWPNP_PNPVEND_PROD_SHIFT 0
#define SPWPNP_PNPVEND_PROD_MASK 0xffffU
#define SPWPNP_PNPVEND_PROD_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffU )
#define SPWPNP_PNPVEND_PROD( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPVER PNPVER
 *
 * @brief SpaceWire Plug-and-Play - Version
 *
 * @{
 */

#define SPWPNP_PNPVER_MAJOR_SHIFT 24
#define SPWPNP_PNPVER_MAJOR_MASK 0xff000000U
#define SPWPNP_PNPVER_MAJOR_GET( _reg ) \
  ( ( ( _reg ) >> 24 ) & 0xffU )
#define SPWPNP_PNPVER_MAJOR( _val ) ( ( _val ) << 24 )

#define SPWPNP_PNPVER_MINOR_SHIFT 16
#define SPWPNP_PNPVER_MINOR_MASK 0xff0000U
#define SPWPNP_PNPVER_MINOR_GET( _reg ) \
  ( ( ( _reg ) >> 16 ) & 0xffU )
#define SPWPNP_PNPVER_MINOR( _val ) ( ( _val ) << 16 )

#define SPWPNP_PNPVER_PATCH_SHIFT 8
#define SPWPNP_PNPVER_PATCH_MASK 0xff00U
#define SPWPNP_PNPVER_PATCH_GET( _reg ) \
  ( ( ( _reg ) >> 8 ) & 0xffU )
#define SPWPNP_PNPVER_PATCH( _val ) ( ( _val ) << 8 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPDEVSTS PNPDEVSTS
 *
 * @brief SpaceWire Plug-and-Play - Device Status
 *
 * @{
 */

#define SPWPNP_PNPDEVSTS_STATUS_SHIFT 0
#define SPWPNP_PNPDEVSTS_STATUS_MASK 0xffU
#define SPWPNP_PNPDEVSTS_STATUS_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffU )
#define SPWPNP_PNPDEVSTS_STATUS( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPACTLNK PNPACTLNK
 *
 * @brief SpaceWire Plug-and-Play - Active Links
 *
 * @{
 */

#define SPWPNP_PNPACTLNK_ACTIVE_SHIFT 1
#define SPWPNP_PNPACTLNK_ACTIVE_MASK 0x1ffeU
#define SPWPNP_PNPACTLNK_ACTIVE_GET( _reg ) \
  ( ( ( _reg ) >> 1 ) & 0xfffU )
#define SPWPNP_PNPACTLNK_ACTIVE( _val ) ( ( _val ) << 1 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPOA0 PNPOA0
 *
 * @brief SpaceWire Plug-and-Play - Owner Address 0
 *
 * @{
 */

#define SPWPNP_PNPOA0_RA_SHIFT 0
#define SPWPNP_PNPOA0_RA_MASK 0xffffffffU
#define SPWPNP_PNPOA0_RA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define SPWPNP_PNPOA0_RA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPOA1 PNPOA1
 *
 * @brief SpaceWire Plug-and-Play - Owner Address 1
 *
 * @{
 */

#define SPWPNP_PNPOA1_RA_SHIFT 0
#define SPWPNP_PNPOA1_RA_MASK 0xffffffffU
#define SPWPNP_PNPOA1_RA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define SPWPNP_PNPOA1_RA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPOA2 PNPOA2
 *
 * @brief SpaceWire Plug-and-Play - Owner Address 2
 *
 * @{
 */

#define SPWPNP_PNPOA2_RA_SHIFT 0
#define SPWPNP_PNPOA2_RA_MASK 0xffffffffU
#define SPWPNP_PNPOA2_RA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define SPWPNP_PNPOA2_RA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPDEVID PNPDEVID
 *
 * @brief SpaceWire Plug-and-Play - Device ID
 *
 * @{
 */

#define SPWPNP_PNPDEVID_DID_SHIFT 0
#define SPWPNP_PNPDEVID_DID_MASK 0xffffffffU
#define SPWPNP_PNPDEVID_DID_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define SPWPNP_PNPDEVID_DID( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPUVEND PNPUVEND
 *
 * @brief SpaceWire Plug-and-Play - Unit Vendor and Product ID
 *
 * @{
 */

#define SPWPNP_PNPUVEND_VEND_SHIFT 16
#define SPWPNP_PNPUVEND_VEND_MASK 0xffff0000U
#define SPWPNP_PNPUVEND_VEND_GET( _reg ) \
  ( ( ( _reg ) >> 16 ) & 0xffffU )
#define SPWPNP_PNPUVEND_VEND( _val ) ( ( _val ) << 16 )

#define SPWPNP_PNPUVEND_PROD_SHIFT 0
#define SPWPNP_PNPUVEND_PROD_MASK 0xffffU
#define SPWPNP_PNPUVEND_PROD_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffU )
#define SPWPNP_PNPUVEND_PROD( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPUSN PNPUSN
 *
 * @brief SpaceWire Plug-and-Play - Unit Serial Number
 *
 * @{
 */

#define SPWPNP_PNPUSN_USN_SHIFT 0
#define SPWPNP_PNPUSN_USN_MASK 0xffffffffU
#define SPWPNP_PNPUSN_USN_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define SPWPNP_PNPUSN_USN( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPVSTRL PNPVSTRL
 *
 * @brief SpaceWire Plug-and-Play - Vendor String Length
 *
 * @{
 */

#define SPWPNP_PNPVSTRL_LEN_SHIFT 0
#define SPWPNP_PNPVSTRL_LEN_MASK 0x7fffU
#define SPWPNP_PNPVSTRL_LEN_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0x7fffU )
#define SPWPNP_PNPVSTRL_LEN( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPPSTRL PNPPSTRL
 *
 * @brief SpaceWire Plug-and-Play - Product String Length
 *
 * @{
 */

#define SPWPNP_PNPPSTRL_LEN_SHIFT 0
#define SPWPNP_PNPPSTRL_LEN_MASK 0x7fffU
#define SPWPNP_PNPPSTRL_LEN_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0x7fffU )
#define SPWPNP_PNPPSTRL_LEN( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPPCNT PNPPCNT
 *
 * @brief SpaceWire Plug-and-Play - Protocol Count
 *
 * @{
 */

#define SPWPNP_PNPPCNT_PC_SHIFT 0
#define SPWPNP_PNPPCNT_PC_MASK 0x1fU
#define SPWPNP_PNPPCNT_PC_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0x1fU )
#define SPWPNP_PNPPCNT_PC( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfSpwpnpPNPACNT PNPACNT
 *
 * @brief SpaceWire Plug-and-Play - Application Count
 *
 * @{
 */

#define SPWPNP_PNPACNT_AC_SHIFT 0
#define SPWPNP_PNPACNT_AC_MASK 0xffU
#define SPWPNP_PNPACNT_AC_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffU )
#define SPWPNP_PNPACNT_AC( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @brief This set of defines the SpaceWire Plug-and-Play address map.
 */
typedef struct {
  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPVEND.
   */
  uint32_t pnpvend;

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPVER.
   */
  uint32_t pnpver;

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPDEVSTS.
   */
  uint32_t pnpdevsts;

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPACTLNK.
   */
  uint32_t pnpactlnk;

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPOA0.
   */
  uint32_t pnpoa0;

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPOA1.
   */
  uint32_t pnpoa1;

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPOA2.
   */
  uint32_t pnpoa2;

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPDEVID.
   */
  uint32_t pnpdevid;

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPUVEND.
   */
  uint32_t pnpuvend;

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPUSN.
   */
  uint32_t pnpusn;

  uint16_t reserved_e_4000[ 8185 ];

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPVSTRL.
   */
  uint32_t pnpvstrl;

  uint32_t reserved_4004_6000[ 2047 ];

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPPSTRL.
   */
  uint32_t pnppstrl;

  uint32_t reserved_6004_8000[ 2047 ];

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPPCNT.
   */
  uint32_t pnppcnt;

  uint32_t reserved_8004_c000[ 4095 ];

  /**
   * @brief See @ref DevGrlibIfSpwpnpPNPACNT.
   */
  uint32_t pnpacnt;
} spwpnp;

/** @} */

#ifdef __cplusplus
}
#endif

#endif /* _DEV_GRLIB_SPWPNP_H */