dt_pwrmgr.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 pwrmgr and top darjeeling.
 */
 
#include "dt/dt_pwrmgr.h"
 
#include "dt_pinmux.h"
#include "dt_aon_timer.h"
#include "dt_soc_proxy.h"
 
 
/**
 * Description of instances.
 */
typedef struct dt_desc_pwrmgr {
  dt_instance_id_t inst_id; /**< Instance ID */
  uint32_t base_addr[kDtPwrmgrRegBlockCount]; /**< 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_darjeeling_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_darjeeling_alert_id_t first_alert;
  dt_clock_t clock[kDtPwrmgrClockCount]; /**< Clock signal connected to each clock port */
  dt_reset_t reset[kDtPwrmgrResetCount]; /**< Reset signal connected to each reset port */
  struct {
    dt_pwrmgr_wakeup_src_t wakeup_src[4]; /**< List of wakeup sources, in the order of the register fields */
    dt_pwrmgr_reset_req_src_t rst_reqs[2]; /**< List of reset requests, in the order of the register fields */
  } ext; /**< Extension */
} dt_desc_pwrmgr_t;
 
 
 
 
static const dt_desc_pwrmgr_t pwrmgr_desc[kDtPwrmgrCount] = {
  [kDtPwrmgrAon] = {
    .inst_id = kDtInstanceIdPwrmgrAon,
    .base_addr = {
      [kDtPwrmgrRegBlockCore] = 0x30400000,
    },
    .first_irq = kTopDarjeelingPlicIrqIdPwrmgrAonWakeup,
    .first_alert = kTopDarjeelingAlertIdPwrmgrAonFatalFault,
    .clock = {
      [kDtPwrmgrClockClk] = kDtClockIoDiv4,
      [kDtPwrmgrClockSlow] = kDtClockAon,
      [kDtPwrmgrClockLc] = kDtClockIoDiv4,
      [kDtPwrmgrClockEsc] = kDtClockIoDiv4,
    },
    .reset = {
      [kDtPwrmgrResetRst] = kDtResetPorIoDiv4,
      [kDtPwrmgrResetMain] = kDtResetPorAon,
      [kDtPwrmgrResetLc] = kDtResetLcIoDiv4,
      [kDtPwrmgrResetEsc] = kDtResetLcIoDiv4,
      [kDtPwrmgrResetSlow] = kDtResetPorAon,
    },
    .ext = {
      .wakeup_src = {
        [0] = {
          .inst_id = kDtInstanceIdPinmuxAon,
          .wakeup = kDtPinmuxWakeupPinWkupReq,
        },
        [1] = {
          .inst_id = kDtInstanceIdAonTimerAon,
          .wakeup = kDtAonTimerWakeupWkupReq,
        },
        [2] = {
          .inst_id = kDtInstanceIdSocProxy,
          .wakeup = kDtSocProxyWakeupWkupInternalReq,
        },
        [3] = {
          .inst_id = kDtInstanceIdSocProxy,
          .wakeup = kDtSocProxyWakeupWkupExternalReq,
        },
      },
      .rst_reqs = {
        [0] = {
          .inst_id = kDtInstanceIdAonTimerAon,
          .reset_req = kDtAonTimerResetReqAonTimer,
        },
        [1] = {
          .inst_id = kDtInstanceIdSocProxy,
          .reset_req = kDtSocProxyResetReqExternal,
        },
      },
    },
  },
};
 
/**
 * Return a pointer to the `dt_pwrmgr_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_pwrmgr_t)0 || (dt) >= kDtPwrmgrCount)       return (default);     &pwrmgr_desc[dt];   })
 
dt_pwrmgr_t dt_pwrmgr_from_instance_id(dt_instance_id_t inst_id) {
  if (inst_id >= kDtInstanceIdPwrmgrAon && inst_id <= kDtInstanceIdPwrmgrAon) {
    return (dt_pwrmgr_t)(inst_id - kDtInstanceIdPwrmgrAon);
  }
  return (dt_pwrmgr_t)0;
}
 
dt_instance_id_t dt_pwrmgr_instance_id(
    dt_pwrmgr_t dt) {
  return TRY_GET_DT(dt, kDtInstanceIdUnknown)->inst_id;
}
 
uint32_t dt_pwrmgr_reg_block(
    dt_pwrmgr_t dt,
    dt_pwrmgr_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_pwrmgr_irq_to_plic_id(
    dt_pwrmgr_t dt,
    dt_pwrmgr_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_pwrmgr_irq_t dt_pwrmgr_irq_from_plic_id(
    dt_pwrmgr_t dt,
    dt_plic_irq_id_t irq) {
  dt_pwrmgr_irq_t count = kDtPwrmgrIrqCount;
  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_pwrmgr_irq_t)(irq - first_irq);
}
 
 
dt_alert_id_t dt_pwrmgr_alert_to_alert_id(
    dt_pwrmgr_t dt,
    dt_pwrmgr_alert_t alert) {
  return (dt_alert_id_t)((uint32_t)pwrmgr_desc[dt].first_alert + (uint32_t)alert);
}
 
dt_pwrmgr_alert_t dt_pwrmgr_alert_from_alert_id(
    dt_pwrmgr_t dt,
    dt_alert_id_t alert) {
  dt_pwrmgr_alert_t count = kDtPwrmgrAlertCount;
  if (alert < pwrmgr_desc[dt].first_alert || alert >= pwrmgr_desc[dt].first_alert + (dt_alert_id_t)count) {
    return count;
  }
  return (dt_pwrmgr_alert_t)(alert - pwrmgr_desc[dt].first_alert);
}
 
 
 
dt_clock_t dt_pwrmgr_clock(
    dt_pwrmgr_t dt,
    dt_pwrmgr_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_pwrmgr_reset(
    dt_pwrmgr_t dt,
    dt_pwrmgr_reset_t rst) {
  const dt_pwrmgr_reset_t count = kDtPwrmgrResetCount;
  if (rst >= count) {
    return kDtResetUnknown;
  }
  return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
}
 
 
size_t dt_pwrmgr_wakeup_src_count(dt_pwrmgr_t dt) {
  return 4;
}
 
dt_pwrmgr_wakeup_src_t dt_pwrmgr_wakeup_src(dt_pwrmgr_t dt, size_t idx) {
  dt_pwrmgr_wakeup_src_t invalid = {.inst_id = kDtInstanceIdUnknown, .wakeup = 0};
  return TRY_GET_DT(dt, invalid)->ext.wakeup_src[idx];
}
 
size_t dt_pwrmgr_reset_request_src_count(dt_pwrmgr_t dt) {
  return 2;
}
 
dt_pwrmgr_reset_req_src_t dt_pwrmgr_reset_request_src(dt_pwrmgr_t dt, size_t idx) {
  dt_pwrmgr_reset_req_src_t invalid = {.inst_id = kDtInstanceIdUnknown, .reset_req = 0};
  return TRY_GET_DT(dt, invalid)->ext.rst_reqs[idx];
}