dt_uart.c

Go to the documentation of this file.

// Copyright lowRISC contributors (OpenTitan project).
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0
//
// Device table API auto-generated by `dtgen`
 
/**
 * @file
 * @brief Device Tables (DT) for IP uart and top earlgrey.
 */
 
#include "hw/top/dt/dt_uart.h"
 
 
 
/**
 * Description of instances.
 */
typedef struct dt_desc_uart {
  dt_instance_id_t inst_id; /**< Instance ID */
  uint32_t base_addr[kDtUartRegBlockCount]; /**< Base address of each register block */
  /**
   * PLIC ID of the first IRQ of this instance
   * 
   * This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
   */
  top_earlgrey_plic_irq_id_t first_irq;
  /**
   * Alert ID of the first Alert of this instance.
   * 
   * This value is undefined if the block is not connected to the Alert Handler.
   */
  top_earlgrey_alert_id_t first_alert;
  dt_clock_t clock[kDtUartClockCount]; /**< Clock signal connected to each clock port */
  dt_reset_t reset[kDtUartResetCount]; /**< Reset signal connected to each reset port */
  dt_periph_io_t periph_io[kDtUartPeriphIoCount]; /**< Description of each peripheral I/O */
} dt_desc_uart_t;
 
 
 
 
static const dt_desc_uart_t uart_desc[kDtUartCount] = {
  [kDtUart0] = {
    .inst_id = kDtInstanceIdUart0,
    .base_addr = {
      [kDtUartRegBlockCore] = 0x40000000,
    },
    .first_irq = kTopEarlgreyPlicIrqIdUart0TxWatermark,
    .first_alert = kTopEarlgreyAlertIdUart0FatalFault,
    .clock = {
      [kDtUartClockClk] = kDtClockIoDiv4,
    },
    .reset = {
      [kDtUartResetRst] = kDtResetLcIoDiv4,
    },
    .periph_io = {
      [kDtUartPeriphIoRx] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInUart0Rx,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtUartPeriphIoTx] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = 0,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselUart0Tx,
        },
      },
    },
  },
  [kDtUart1] = {
    .inst_id = kDtInstanceIdUart1,
    .base_addr = {
      [kDtUartRegBlockCore] = 0x40010000,
    },
    .first_irq = kTopEarlgreyPlicIrqIdUart1TxWatermark,
    .first_alert = kTopEarlgreyAlertIdUart1FatalFault,
    .clock = {
      [kDtUartClockClk] = kDtClockIoDiv4,
    },
    .reset = {
      [kDtUartResetRst] = kDtResetLcIoDiv4,
    },
    .periph_io = {
      [kDtUartPeriphIoRx] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInUart1Rx,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtUartPeriphIoTx] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = 0,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselUart1Tx,
        },
      },
    },
  },
  [kDtUart2] = {
    .inst_id = kDtInstanceIdUart2,
    .base_addr = {
      [kDtUartRegBlockCore] = 0x40020000,
    },
    .first_irq = kTopEarlgreyPlicIrqIdUart2TxWatermark,
    .first_alert = kTopEarlgreyAlertIdUart2FatalFault,
    .clock = {
      [kDtUartClockClk] = kDtClockIoDiv4,
    },
    .reset = {
      [kDtUartResetRst] = kDtResetLcIoDiv4,
    },
    .periph_io = {
      [kDtUartPeriphIoRx] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInUart2Rx,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtUartPeriphIoTx] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = 0,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselUart2Tx,
        },
      },
    },
  },
  [kDtUart3] = {
    .inst_id = kDtInstanceIdUart3,
    .base_addr = {
      [kDtUartRegBlockCore] = 0x40030000,
    },
    .first_irq = kTopEarlgreyPlicIrqIdUart3TxWatermark,
    .first_alert = kTopEarlgreyAlertIdUart3FatalFault,
    .clock = {
      [kDtUartClockClk] = kDtClockIoDiv4,
    },
    .reset = {
      [kDtUartResetRst] = kDtResetLcIoDiv4,
    },
    .periph_io = {
      [kDtUartPeriphIoRx] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirIn,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInUart3Rx,
          .outsel_or_dt_pad = 0,
        },
      },
      [kDtUartPeriphIoTx] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirOut,
          .periph_input_or_direct_pad = 0,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselUart3Tx,
        },
      },
    },
  },
};
 
/**
 * Return a pointer to the `dt_uart_desc_t` structure of the requested
 * `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
 * the function) with the provided default value.
 */
#define TRY_GET_DT(dt, default)   ({     if ((dt) < (dt_uart_t)0 || (dt) >= kDtUartCount)       return (default);     &uart_desc[dt];   })
 
dt_uart_t dt_uart_from_instance_id(dt_instance_id_t inst_id) {
  if (inst_id >= kDtInstanceIdUart0 && inst_id <= kDtInstanceIdUart3) {
    return (dt_uart_t)(inst_id - kDtInstanceIdUart0);
  }
  return (dt_uart_t)0;
}
 
dt_instance_id_t dt_uart_instance_id(
    dt_uart_t dt) {
  return TRY_GET_DT(dt, kDtInstanceIdUnknown)->inst_id;
}
 
uint32_t dt_uart_reg_block(
    dt_uart_t dt,
    dt_uart_reg_block_t reg_block) {
  // Return a recognizable address in case of wrong argument.
  return TRY_GET_DT(dt, 0xdeadbeef)->base_addr[reg_block];
}
 
dt_plic_irq_id_t dt_uart_irq_to_plic_id(
    dt_uart_t dt,
    dt_uart_irq_t irq) {
  dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, kDtPlicIrqIdNone)->first_irq;
  if (first_irq == kDtPlicIrqIdNone) {
    return kDtPlicIrqIdNone;
  }
  return (dt_plic_irq_id_t)((uint32_t)first_irq + (uint32_t)irq);
}
 
dt_uart_irq_t dt_uart_irq_from_plic_id(
    dt_uart_t dt,
    dt_plic_irq_id_t irq) {
  dt_uart_irq_t count = kDtUartIrqCount;
  dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, count)->first_irq;
  if (first_irq == kDtPlicIrqIdNone) {
    return count;
  }
  if (irq < first_irq || irq >= first_irq + (dt_plic_irq_id_t)count) {
    return count;
  }
  return (dt_uart_irq_t)(irq - first_irq);
}
 
 
dt_alert_id_t dt_uart_alert_to_alert_id(
    dt_uart_t dt,
    dt_uart_alert_t alert) {
  return (dt_alert_id_t)((uint32_t)uart_desc[dt].first_alert + (uint32_t)alert);
}
 
dt_uart_alert_t dt_uart_alert_from_alert_id(
    dt_uart_t dt,
    dt_alert_id_t alert) {
  dt_uart_alert_t count = kDtUartAlertCount;
  if (alert < uart_desc[dt].first_alert || alert >= uart_desc[dt].first_alert + (dt_alert_id_t)count) {
    return count;
  }
  return (dt_uart_alert_t)(alert - uart_desc[dt].first_alert);
}
 
 
dt_periph_io_t dt_uart_periph_io(
    dt_uart_t dt,
    dt_uart_periph_io_t sig) {
  // Return a harmless value in case of wrong argument.
  return TRY_GET_DT(dt, kDtPeriphIoConstantHighZ)->periph_io[sig];
}
 
dt_clock_t dt_uart_clock(
    dt_uart_t dt,
    dt_uart_clock_t clk) {
  // Return the first clock in case of invalid argument.
  return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
}
 
dt_reset_t dt_uart_reset(
    dt_uart_t dt,
    dt_uart_reset_t rst) {
  const dt_uart_reset_t count = kDtUartResetCount;
  if (rst >= count) {
    return kDtResetUnknown;
  }
  return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
}