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

/**
 * @file
 *
 * @ingroup RTEMSBSPsARMLPC176X
 *
 * @brief Console configuration.
 */

/*
 * Copyright (C) 2008, 2014 embedded brains GmbH & Co. KG
 *
 * 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.
 */

#include <libchip/ns16550.h>

#include <bsp.h>
#include <bsp/io.h>
#include <bsp/irq.h>
#include <bsp/console-termios.h>

/**
 * @brief Gets the uart register according to the current address.
 *
 * @param  addr Register address.
 * @param  i Index register.
 * @return  Uart register.
 */
static inline uint8_t lpc176x_uart_get_register(
  const uintptr_t addr,
  const uint8_t   i
)
{
  volatile uint32_t *reg = (volatile uint32_t *) addr;

  return (uint8_t) reg[ i ];
}

/**
 * @brief Sets the uart register address according to the value passed.
 *
 * @param  addr Register address.
 * @param  i Index register.
 * @param val Value to set.
 */
static inline void lpc176x_uart_set_register(
  const uintptr_t addr,
  const uint8_t   i,
  const uint8_t   val
)
{
  volatile uint32_t *reg = (volatile uint32_t *) addr;

  reg[ i ] = val;
}

static bool lpc176x_uart1_probe(rtems_termios_device_context *ctx)
{
  (void)ctx;

  lpc176x_module_enable( LPC176X_MODULE_UART_1, LPC176X_MODULE_PCLK_DEFAULT );

  lpc176x_pin_select( LPC176X_PIN_UART_1_TXD, LPC176X_PIN_FUNCTION_01 );
  lpc176x_pin_select( LPC176X_PIN_UART_1_RXD, LPC176X_PIN_FUNCTION_01 );

  return true;
}

#ifdef LPC176X_CONFIG_UART_2
static bool lpc176x_uart2_probe(rtems_termios_device_context *ctx)
{
  (void)ctx;

  lpc176x_module_enable( LPC176X_MODULE_UART_2, LPC176X_MODULE_PCLK_DEFAULT );

  lpc176x_pin_select( LPC176X_PIN_UART_2_TXD, LPC176X_PIN_FUNCTION_01 );
  lpc176x_pin_select( LPC176X_PIN_UART_2_RXD, LPC176X_PIN_FUNCTION_01 );

  return true;
}
#endif

#ifdef LPC176X_CONFIG_UART_3
static bool lpc176x_uart3_probe(rtems_termios_device_context *ctx)
{
  (void)ctx;

  lpc176x_module_enable( LPC176X_MODULE_UART_3, LPC176X_MODULE_PCLK_DEFAULT );

  lpc176x_pin_select( LPC176X_PIN_UART_3_TXD, LPC176X_PIN_FUNCTION_10 );
  lpc176x_pin_select( LPC176X_PIN_UART_3_RXD, LPC176X_PIN_FUNCTION_10 );

  return true;
}
#endif

#ifdef LPC176X_CONFIG_CONSOLE
static ns16550_context lpc176x_uart_context_0 = {
  .base = RTEMS_TERMIOS_DEVICE_CONTEXT_INITIALIZER("UART 0"),
  .get_reg = lpc176x_uart_get_register,
  .set_reg = lpc176x_uart_set_register,
  .port = UART0_BASE_ADDR,
  .irq = LPC176X_IRQ_UART_0,
  .clock = LPC176X_PCLK,
  .initial_baud = LPC176X_UART_BAUD,
  .has_fractional_divider_register = true
};
#endif

#ifdef LPC176X_CONFIG_UART_1
static ns16550_context lpc176x_uart_context_1 = {
  .base = RTEMS_TERMIOS_DEVICE_CONTEXT_INITIALIZER("UART 1"),
  .get_reg = lpc176x_uart_get_register,
  .set_reg = lpc176x_uart_set_register,
  .port = UART1_BASE_ADDR,
  .irq = LPC176X_IRQ_UART_1,
  .clock = LPC176X_PCLK,
  .initial_baud = LPC176X_UART_BAUD,
  .has_fractional_divider_register = true
};
#endif

#ifdef LPC176X_CONFIG_UART_2
static ns16550_context lpc176x_uart_context_2 = {
  .base = RTEMS_TERMIOS_DEVICE_CONTEXT_INITIALIZER("UART 2"),
  .get_reg = lpc176x_uart_get_register,
  .set_reg = lpc176x_uart_set_register,
  .port = UART2_BASE_ADDR,
  .irq = LPC176X_IRQ_UART_2,
  .clock = LPC176X_PCLK,
  .initial_baud = LPC176X_UART_BAUD,
  .has_fractional_divider_register = true
};
#endif

#ifdef LPC176X_CONFIG_UART_3
static ns16550_context lpc176x_uart_context_3 = {
  .base = RTEMS_TERMIOS_DEVICE_CONTEXT_INITIALIZER("UART 3"),
  .get_reg = lpc176x_uart_get_register,
  .set_reg = lpc176x_uart_set_register,
  .port = UART3_BASE_ADDR,
  .irq = LPC176X_IRQ_UART_3,
  .clock = LPC176X_PCLK,
  .initial_baud = LPC176X_UART_BAUD,
  .has_fractional_divider_register = true
};
#endif

const console_device console_device_table[] = {
  #ifdef LPC176X_CONFIG_CONSOLE
    {
      .device_file = "/dev/ttyS0",
      .probe = console_device_probe_default,
      .handler = &ns16550_handler_interrupt,
      .context = &lpc176x_uart_context_0.base
    },
  #endif
  #ifdef LPC176X_CONFIG_UART_1
    {
      .device_file = "/dev/ttyS1",
      .probe = lpc176x_uart1_probe,
      .handler = &ns16550_handler_interrupt,
      .context = &lpc176x_uart_context_1.base
    },
  #endif
  #ifdef LPC176X_CONFIG_UART_2
    {
      .device_file = "/dev/ttyS2",
      .probe = lpc176x_uart2_probe,
      .handler = &ns16550_handler_interrupt,
      .context = &lpc176x_uart_context_2.base
    },
  #endif
  #ifdef LPC176X_CONFIG_UART_3
    {
      .device_file = "/dev/ttyS3",
      .probe = lpc176x_uart3_probe,
      .handler = &ns16550_handler_interrupt,
      .context = &lpc176x_uart_context_3.base
    },
  #endif
};

const size_t console_device_count = RTEMS_ARRAY_SIZE(console_device_table);