/****************************************************************************
 * arch/arm/src/stm32f7/stm32_dumpgpio.c
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#include <sys/types.h>
#include <assert.h>
#include <debug.h>

#include <nuttx/irq.h>
#include <arch/stm32f7/chip.h>

#include "arm_internal.h"
#include "chip.h"
#include "stm32_gpio.h"
#include "stm32_rcc.h"

#ifdef CONFIG_DEBUG_GPIO_INFO

/* Content of this file requires verification before it is used with other
 * families
 */

#if defined(CONFIG_STM32F7_STM32F74XX) || defined(CONFIG_STM32F7_STM32F75XX) \
  || defined(CONFIG_STM32F7_STM32F74XX) || defined(CONFIG_STM32F7_STM32F75XX) \
  || defined(CONFIG_STM32F7_STM32F76XX) || defined(CONFIG_STM32F7_STM32F77XX)

/****************************************************************************
 * Private Data
 ****************************************************************************/

/* Port letters for prettier debug output */

static const char g_portchar[STM32F7_NGPIO] =
{
#if STM32F7_NGPIO > 11
#  error "Additional support required for this number of GPIOs"
#elif STM32F7_NGPIO > 10
  'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K'
#elif STM32F7_NGPIO > 9
  'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J'
#elif STM32F7_NGPIO > 8
  'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I'
#elif STM32F7_NGPIO > 7
  'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H'
#elif STM32F7_NGPIO > 6
  'A', 'B', 'C', 'D', 'E', 'F', 'G'
#elif STM32F7_NGPIO > 5
  'A', 'B', 'C', 'D', 'E', 'F'
#elif STM32F7_NGPIO > 4
  'A', 'B', 'C', 'D', 'E'
#elif STM32F7_NGPIO > 3
  'A', 'B', 'C', 'D'
#elif STM32F7_NGPIO > 2
  'A', 'B', 'C'
#elif STM32F7_NGPIO > 1
  'A', 'B'
#elif STM32F7_NGPIO > 0
  'A'
#else
#  error "Bad number of GPIOs"
#endif
};

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Function:  stm32_dumpgpio
 *
 * Description:
 *   Dump all GPIO registers associated with the provided pin configuration
 *
 ****************************************************************************/

int stm32_dumpgpio(uint32_t pinset, const char *msg)
{
  irqstate_t   flags;
  uint32_t     base;
  unsigned int port;

  /* Get the base address associated with the GPIO port */

  port = (pinset & GPIO_PORT_MASK) >> GPIO_PORT_SHIFT;
  base = g_gpiobase[port];

  /* The following requires exclusive access to the GPIO registers */

  flags = enter_critical_section();

  DEBUGASSERT(port < STM32F7_NGPIO);

  gpioinfo("GPIO%c pinset: %08x base: %08x -- %s\n",
        g_portchar[port], pinset, base, msg);

  if ((getreg32(STM32_RCC_AHB1ENR) & RCC_AHB1ENR_GPIOEN(port)) != 0)
    {
      gpioinfo(" MODE: %08x OTYPE: %04x     OSPEED: %08x PUPDR: %08x\n",
               getreg32(base + STM32_GPIO_MODER_OFFSET),
               getreg32(base + STM32_GPIO_OTYPER_OFFSET),
               getreg32(base + STM32_GPIO_OSPEED_OFFSET),
               getreg32(base + STM32_GPIO_PUPDR_OFFSET));
      gpioinfo("  IDR: %04x       ODR: %04x       LCKR: %05x\n",
               getreg32(base + STM32_GPIO_IDR_OFFSET),
               getreg32(base + STM32_GPIO_ODR_OFFSET),
               getreg32(base + STM32_GPIO_LCKR_OFFSET));
      gpioinfo(" AFRH: %08x  AFRL: %08x\n",
               getreg32(base + STM32_GPIO_AFRH_OFFSET),
               getreg32(base + STM32_GPIO_AFRL_OFFSET));
    }
  else
    {
      gpioinfo("  GPIO%c not enabled: AHB1ENR: %08x\n",
               g_portchar[port], getreg32(STM32_RCC_AHB1ENR));
    }

  leave_critical_section(flags);
  return OK;
}

#endif /* CONFIG_STM32F7_STM32F74XX || CONFIG_STM32F7_STM32F75XX */
#endif /* CONFIG_DEBUG_GPIO_INFO */