dt_i2c.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 i2c and top earlgrey.
 */
 
#include "hw/top/dt/dt_i2c.h"
 
 
 
/**
 * Description of instances.
 */
typedef struct dt_desc_i2c {
  dt_instance_id_t inst_id; /**< Instance ID */
  uint32_t base_addr[kDtI2cRegBlockCount]; /**< 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[kDtI2cClockCount]; /**< Clock signal connected to each clock port */
  dt_reset_t reset[kDtI2cResetCount]; /**< Reset signal connected to each reset port */
  dt_periph_io_t periph_io[kDtI2cPeriphIoCount]; /**< Description of each peripheral I/O */
} dt_desc_i2c_t;
 
 
 
 
static const dt_desc_i2c_t i2c_desc[kDtI2cCount] = {
  [kDtI2c0] = {
    .inst_id = kDtInstanceIdI2c0,
    .base_addr = {
      [kDtI2cRegBlockCore] = 0x40080000,
    },
    .first_irq = kTopEarlgreyPlicIrqIdI2c0FmtThreshold,
    .first_alert = kTopEarlgreyAlertIdI2c0FatalFault,
    .clock = {
      [kDtI2cClockClk] = kDtClockIoDiv4,
    },
    .reset = {
      [kDtI2cResetRst] = kDtResetI2c0,
    },
    .periph_io = {
      [kDtI2cPeriphIoSda] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirInout,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInI2c0Sda,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselI2c0Sda,
        },
      },
      [kDtI2cPeriphIoScl] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirInout,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInI2c0Scl,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselI2c0Scl,
        },
      },
    },
  },
  [kDtI2c1] = {
    .inst_id = kDtInstanceIdI2c1,
    .base_addr = {
      [kDtI2cRegBlockCore] = 0x40090000,
    },
    .first_irq = kTopEarlgreyPlicIrqIdI2c1FmtThreshold,
    .first_alert = kTopEarlgreyAlertIdI2c1FatalFault,
    .clock = {
      [kDtI2cClockClk] = kDtClockIoDiv4,
    },
    .reset = {
      [kDtI2cResetRst] = kDtResetI2c1,
    },
    .periph_io = {
      [kDtI2cPeriphIoSda] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirInout,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInI2c1Sda,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselI2c1Sda,
        },
      },
      [kDtI2cPeriphIoScl] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirInout,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInI2c1Scl,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselI2c1Scl,
        },
      },
    },
  },
  [kDtI2c2] = {
    .inst_id = kDtInstanceIdI2c2,
    .base_addr = {
      [kDtI2cRegBlockCore] = 0x400A0000,
    },
    .first_irq = kTopEarlgreyPlicIrqIdI2c2FmtThreshold,
    .first_alert = kTopEarlgreyAlertIdI2c2FatalFault,
    .clock = {
      [kDtI2cClockClk] = kDtClockIoDiv4,
    },
    .reset = {
      [kDtI2cResetRst] = kDtResetI2c2,
    },
    .periph_io = {
      [kDtI2cPeriphIoSda] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirInout,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInI2c2Sda,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselI2c2Sda,
        },
      },
      [kDtI2cPeriphIoScl] = {
        .__internal = {
          .type = kDtPeriphIoTypeMio,
          .dir = kDtPeriphIoDirInout,
          .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInI2c2Scl,
          .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselI2c2Scl,
        },
      },
    },
  },
};
 
/**
 * Return a pointer to the `dt_i2c_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_i2c_t)0 || (dt) >= kDtI2cCount)       return (default);     &i2c_desc[dt];   })
 
dt_i2c_t dt_i2c_from_instance_id(dt_instance_id_t inst_id) {
  if (inst_id >= kDtInstanceIdI2c0 && inst_id <= kDtInstanceIdI2c2) {
    return (dt_i2c_t)(inst_id - kDtInstanceIdI2c0);
  }
  return (dt_i2c_t)0;
}
 
dt_instance_id_t dt_i2c_instance_id(
    dt_i2c_t dt) {
  return TRY_GET_DT(dt, kDtInstanceIdUnknown)->inst_id;
}
 
uint32_t dt_i2c_reg_block(
    dt_i2c_t dt,
    dt_i2c_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_i2c_irq_to_plic_id(
    dt_i2c_t dt,
    dt_i2c_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_i2c_irq_t dt_i2c_irq_from_plic_id(
    dt_i2c_t dt,
    dt_plic_irq_id_t irq) {
  dt_i2c_irq_t count = kDtI2cIrqCount;
  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_i2c_irq_t)(irq - first_irq);
}
 
 
dt_alert_id_t dt_i2c_alert_to_alert_id(
    dt_i2c_t dt,
    dt_i2c_alert_t alert) {
  return (dt_alert_id_t)((uint32_t)i2c_desc[dt].first_alert + (uint32_t)alert);
}
 
dt_i2c_alert_t dt_i2c_alert_from_alert_id(
    dt_i2c_t dt,
    dt_alert_id_t alert) {
  dt_i2c_alert_t count = kDtI2cAlertCount;
  if (alert < i2c_desc[dt].first_alert || alert >= i2c_desc[dt].first_alert + (dt_alert_id_t)count) {
    return count;
  }
  return (dt_i2c_alert_t)(alert - i2c_desc[dt].first_alert);
}
 
 
dt_periph_io_t dt_i2c_periph_io(
    dt_i2c_t dt,
    dt_i2c_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_i2c_clock(
    dt_i2c_t dt,
    dt_i2c_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_i2c_reset(
    dt_i2c_t dt,
    dt_i2c_reset_t rst) {
  const dt_i2c_reset_t count = kDtI2cResetCount;
  if (rst >= count) {
    return kDtResetUnknown;
  }
  return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
}