linux-imx

/* SPDX-License-Identifier: GPL-2.0-only */

/*

 * Generic OPP Interface

 *

 * Copyright (C) 2009-2010 Texas Instruments Incorporated.

 *  Nishanth Menon

 *  Romit Dasgupta

 *  Kevin Hilman

 */

​

#ifndef __DRIVER_OPP_H__

#define __DRIVER_OPP_H__

​

#include <linux/device.h>

#include <linux/kernel.h>

#include <linux/kref.h>

#include <linux/list.h>

#include <linux/limits.h>

#include <linux/pm_opp.h>

#include <linux/notifier.h>

​

struct clk;

struct regulator;

​

/* Lock to allow exclusive modification to the device and opp lists */

extern struct mutex opp_table_lock;

​

extern struct list_head opp_tables;

​

/*

 * Internal data structure organization with the OPP layer library is as

 * follows:

 * opp_tables (root)

 *  |- device 1 (represents voltage domain 1)

 *  |   |- opp 1 (availability, freq, voltage)

 *  |   |- opp 2 ..

 *  ... ...

 *  |   `- opp n ..

 *  |- device 2 (represents the next voltage domain)

 *  ...

 *  `- device m (represents mth voltage domain)

 * device 1, 2.. are represented by opp_table structure while each opp

 * is represented by the opp structure.

 */

​

/**

 * struct dev_pm_opp - Generic OPP description structure

 * @node:   opp table node. The nodes are maintained throughout the lifetime

 *      of boot. It is expected only an optimal set of OPPs are

 *      added to the library by the SoC framework.

 *      IMPORTANT: the opp nodes should be maintained in increasing

 *      order.

 * @kref:   for reference count of the OPP.

 * @available:  true/false - marks if this OPP as available or not

 * @dynamic:    not-created from static DT entries.

 * @turbo:  true if turbo (boost) OPP

 * @suspend:    true if suspend OPP

 * @pstate: Device's power domain's performance state.

 * @rate:   Frequency in hertz

 * @level:  Performance level

 * @supplies:   Power supplies voltage/current values

 * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's

 *      frequency from any other OPP's frequency.