dif_pwm_autogen.h

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
 
 
 
#ifndef OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_PWM_AUTOGEN_H_
#define OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_PWM_AUTOGEN_H_
 
// THIS FILE HAS BEEN GENERATED, DO NOT EDIT MANUALLY. COMMAND:
// util/autogen_dif.py -i hw/top_earlgrey/ip_autogen/pwm/data/pwm.hjson
// -o bazel-out/k8-fastbuild/bin/sw/device/lib/dif/autogen
 
 
/**
 * @file
 * @brief <a href="/book/hw/ip/pwm/">PWM</a> Device Interface Functions
 */
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sw/device/lib/base/macros.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"
#include "dt/dt_pwm.h" // Generated.
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * A handle to pwm.
 *
 * This type should be treated as opaque by users.
 */
typedef struct dif_pwm {
  /**
   * The base address for the pwm hardware registers.
   */
  mmio_region_t base_addr;
  /**
   * The instance, set to `kDtPwmCount` if not initialized
   * through `dif_pwm_init_from_dt`.
   */
  dt_pwm_t dt;
} dif_pwm_t;
 
/**
 * Creates a new handle for a(n) pwm peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param base_addr The MMIO base address of the pwm peripheral.
 * @param[out] pwm Out param for the initialized handle.
 * @return The result of the operation.
 *
 * DEPRECATED This function exists solely for the transition to
 * dt-based DIFs and will be removed in the future.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_pwm_init(
  mmio_region_t base_addr,
  dif_pwm_t *pwm);
 
/**
 * Creates a new handle for a(n) pwm peripheral.
 *
 * This function does not actuate the hardware.
 *
 * @param dt The devicetable description of the device.
 * @param[out] pwm Out param for the initialized handle.
 * @return The result of the operation.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_pwm_init_from_dt(
  dt_pwm_t dt,
  dif_pwm_t *pwm);
 
/**
 * Get the DT handle from this DIF.
 *
 * If this DIF was initialized by `dif_pwm_init_from_dt(dt, ..)`
 * then this function will return `dt`. Otherwise it will return an error.
 *
 * @param pwm A pwm handle.
 * @param[out] dt DT handle.
 * @return `kDifBadArg` if the DIF has no DT information, `kDifOk` otherwise.
 */
OT_WARN_UNUSED_RESULT
dif_result_t dif_pwm_get_dt(
  const dif_pwm_t *pwm,
  dt_pwm_t *dt);
 
  /**
   * A pwm alert type.
   */
  typedef enum dif_pwm_alert {
    /**
     * This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.
     */
      kDifPwmAlertFatalFault = 0,
  } dif_pwm_alert_t;
 
  /**
   * Forces a particular alert, causing it to be escalated as if the hardware
   * had raised it.
   *
   * @param pwm A pwm handle.
   * @param alert The alert to force.
   * @return The result of the operation.
   */
  OT_WARN_UNUSED_RESULT
  dif_result_t dif_pwm_alert_force(
    const dif_pwm_t *pwm,
    dif_pwm_alert_t alert);
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_SW_DEVICE_LIB_DIF_AUTOGEN_DIF_PWM_AUTOGEN_H_