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

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

/**
 * @file
 *
 * @ingroup RTEMSDeviceGRLIB
 *
 * @brief This header file defines the GRGPIO 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/grgpio-header */

#ifndef _DEV_GRLIB_GRGPIO_H
#define _DEV_GRLIB_GRGPIO_H

#ifdef __cplusplus
extern "C" {
#endif

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

/**
 * @defgroup DevGrlibIfGrgpio GRGPIO
 *
 * @ingroup RTEMSDeviceGRLIB
 *
 * @brief This group contains the GRGPIO interfaces.
 *
 * @{
 */

/**
 * @defgroup DevGrlibIfGrgpioDATA DATA
 *
 * @brief I/O port data register
 *
 * @{
 */

#define GRGPIO_DATA_DATA_SHIFT 0
#define GRGPIO_DATA_DATA_MASK 0xffffffffU
#define GRGPIO_DATA_DATA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_DATA_DATA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioOUTPUT OUTPUT
 *
 * @brief I/O port output register
 *
 * @{
 */

#define GRGPIO_OUTPUT_DATA_SHIFT 0
#define GRGPIO_OUTPUT_DATA_MASK 0xffffffffU
#define GRGPIO_OUTPUT_DATA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_OUTPUT_DATA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioDIRECTION DIRECTION
 *
 * @brief I/O port direction register
 *
 * @{
 */

#define GRGPIO_DIRECTION_DIR_SHIFT 0
#define GRGPIO_DIRECTION_DIR_MASK 0xffffffffU
#define GRGPIO_DIRECTION_DIR_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_DIRECTION_DIR( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioIMASK IMASK
 *
 * @brief Interrupt mask register
 *
 * @{
 */

#define GRGPIO_IMASK_MASK_SHIFT 0
#define GRGPIO_IMASK_MASK_MASK 0xffffffffU
#define GRGPIO_IMASK_MASK_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_IMASK_MASK( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioIPOL IPOL
 *
 * @brief Interrupt polarity register
 *
 * @{
 */

#define GRGPIO_IPOL_POL_SHIFT 0
#define GRGPIO_IPOL_POL_MASK 0xffffffffU
#define GRGPIO_IPOL_POL_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_IPOL_POL( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioIEDGE IEDGE
 *
 * @brief Interrupt edge register
 *
 * @{
 */

#define GRGPIO_IEDGE_EDGE_SHIFT 0
#define GRGPIO_IEDGE_EDGE_MASK 0xffffffffU
#define GRGPIO_IEDGE_EDGE_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_IEDGE_EDGE( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioBYPASS BYPASS
 *
 * @brief Bypass register
 *
 * @{
 */

#define GRGPIO_BYPASS_BYPASS_SHIFT 0
#define GRGPIO_BYPASS_BYPASS_MASK 0xffffffffU
#define GRGPIO_BYPASS_BYPASS_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_BYPASS_BYPASS( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioCAP CAP
 *
 * @brief Capability register
 *
 * @{
 */

#define GRGPIO_CAP_PU 0x40000U

#define GRGPIO_CAP_IER 0x20000U

#define GRGPIO_CAP_IFL 0x10000U

#define GRGPIO_CAP_IRQGEN_SHIFT 8
#define GRGPIO_CAP_IRQGEN_MASK 0x1f00U
#define GRGPIO_CAP_IRQGEN_GET( _reg ) \
  ( ( ( _reg ) >> 8 ) & 0x1fU )
#define GRGPIO_CAP_IRQGEN( _val ) ( ( _val ) << 8 )

#define GRGPIO_CAP_NLINES_SHIFT 0
#define GRGPIO_CAP_NLINES_MASK 0x1fU
#define GRGPIO_CAP_NLINES_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0x1fU )
#define GRGPIO_CAP_NLINES( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioIRQMAPR IRQMAPR
 *
 * @brief Interrupt map register n, where n = 0 .. 3
 *
 * @{
 */

#define GRGPIO_IRQMAPR_IRQMAP_I_SHIFT 24
#define GRGPIO_IRQMAPR_IRQMAP_I_MASK 0x7f000000U
#define GRGPIO_IRQMAPR_IRQMAP_I_GET( _reg ) \
  ( ( ( _reg ) >> 24 ) & 0x7fU )
#define GRGPIO_IRQMAPR_IRQMAP_I( _val ) ( ( _val ) << 24 )

#define GRGPIO_IRQMAPR_IRQMAP_I_1_SHIFT 16
#define GRGPIO_IRQMAPR_IRQMAP_I_1_MASK 0x1f0000U
#define GRGPIO_IRQMAPR_IRQMAP_I_1_GET( _reg ) \
  ( ( ( _reg ) >> 16 ) & 0x1fU )
#define GRGPIO_IRQMAPR_IRQMAP_I_1( _val ) ( ( _val ) << 16 )

#define GRGPIO_IRQMAPR_IRQMAP_I_2_SHIFT 8
#define GRGPIO_IRQMAPR_IRQMAP_I_2_MASK 0x1f00U
#define GRGPIO_IRQMAPR_IRQMAP_I_2_GET( _reg ) \
  ( ( ( _reg ) >> 8 ) & 0x1fU )
#define GRGPIO_IRQMAPR_IRQMAP_I_2( _val ) ( ( _val ) << 8 )

#define GRGPIO_IRQMAPR_IRQMAP_I_3 0x10U

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioIAVAIL IAVAIL
 *
 * @brief Interrupt available register
 *
 * @{
 */

#define GRGPIO_IAVAIL_IMASK_SHIFT 0
#define GRGPIO_IAVAIL_IMASK_MASK 0xffffffffU
#define GRGPIO_IAVAIL_IMASK_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_IAVAIL_IMASK( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioIFLAG IFLAG
 *
 * @brief Interrupt flag register
 *
 * @{
 */

#define GRGPIO_IFLAG_IFLAG_SHIFT 0
#define GRGPIO_IFLAG_IFLAG_MASK 0xffffffffU
#define GRGPIO_IFLAG_IFLAG_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_IFLAG_IFLAG( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioIPEN IPEN
 *
 * @brief Interrupt enable register
 *
 * @{
 */

#define GRGPIO_IPEN_IPEN_SHIFT 0
#define GRGPIO_IPEN_IPEN_MASK 0xffffffffU
#define GRGPIO_IPEN_IPEN_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_IPEN_IPEN( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioPULSE PULSE
 *
 * @brief Pulse register
 *
 * @{
 */

#define GRGPIO_PULSE_PULSE_SHIFT 0
#define GRGPIO_PULSE_PULSE_MASK 0xffffffffU
#define GRGPIO_PULSE_PULSE_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_PULSE_PULSE( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioLOR LOR
 *
 * @brief Logical-OR registers
 *
 * @{
 */

#define GRGPIO_LOR_DATA_SHIFT 0
#define GRGPIO_LOR_DATA_MASK 0xffffffffU
#define GRGPIO_LOR_DATA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_LOR_DATA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioLAND LAND
 *
 * @brief Logical-AND registers
 *
 * @{
 */

#define GRGPIO_LAND_DATA_SHIFT 0
#define GRGPIO_LAND_DATA_MASK 0xffffffffU
#define GRGPIO_LAND_DATA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_LAND_DATA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfGrgpioLXOR LXOR
 *
 * @brief Logical-XOR registers
 *
 * @{
 */

#define GRGPIO_LXOR_DATA_SHIFT 0
#define GRGPIO_LXOR_DATA_MASK 0xffffffffU
#define GRGPIO_LXOR_DATA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffffffffU )
#define GRGPIO_LXOR_DATA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @brief This structure defines the GRGPIO register block memory map.
 */
typedef struct {
  /**
   * @brief See @ref DevGrlibIfGrgpioDATA.
   */
  uint32_t data;

  /**
   * @brief See @ref DevGrlibIfGrgpioOUTPUT.
   */
  uint32_t output;

  /**
   * @brief See @ref DevGrlibIfGrgpioDIRECTION.
   */
  uint32_t direction;

  /**
   * @brief See @ref DevGrlibIfGrgpioIMASK.
   */
  uint32_t imask;

  /**
   * @brief See @ref DevGrlibIfGrgpioIPOL.
   */
  uint32_t ipol;

  /**
   * @brief See @ref DevGrlibIfGrgpioIEDGE.
   */
  uint32_t iedge;

  /**
   * @brief See @ref DevGrlibIfGrgpioBYPASS.
   */
  uint32_t bypass;

  /**
   * @brief See @ref DevGrlibIfGrgpioCAP.
   */
  uint32_t cap;

  /**
   * @brief See @ref DevGrlibIfGrgpioIRQMAPR.
   */
  uint32_t irqmapr[ 8 ];

  /**
   * @brief See @ref DevGrlibIfGrgpioIAVAIL.
   */
  uint32_t iavail;

  /**
   * @brief See @ref DevGrlibIfGrgpioIFLAG.
   */
  uint32_t iflag;

  /**
   * @brief See @ref DevGrlibIfGrgpioIPEN.
   */
  uint32_t ipen;

  /**
   * @brief See @ref DevGrlibIfGrgpioPULSE.
   */
  uint32_t pulse;

  uint32_t reserved_50_54;

  /**
   * @brief See @ref DevGrlibIfGrgpioLOR.
   */
  uint32_t lor_output;

  /**
   * @brief See @ref DevGrlibIfGrgpioLOR.
   */
  uint32_t lor_direction;

  /**
   * @brief See @ref DevGrlibIfGrgpioLOR.
   */
  uint32_t lor_imask;

  uint32_t reserved_60_64;

  /**
   * @brief See @ref DevGrlibIfGrgpioLAND.
   */
  uint32_t land_output;

  /**
   * @brief See @ref DevGrlibIfGrgpioLAND.
   */
  uint32_t land_direction;

  /**
   * @brief See @ref DevGrlibIfGrgpioLAND.
   */
  uint32_t land_imask;

  uint32_t reserved_70_74;

  /**
   * @brief See @ref DevGrlibIfGrgpioLXOR.
   */
  uint32_t lxor_output;

  /**
   * @brief See @ref DevGrlibIfGrgpioLXOR.
   */
  uint32_t lxor_direction;

  /**
   * @brief See @ref DevGrlibIfGrgpioLXOR.
   */
  uint32_t lxor_imask;
} grgpio;

/** @} */

#ifdef __cplusplus
}
#endif

#endif /* _DEV_GRLIB_GRGPIO_H */