Something went wrong. Try again.
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119/* SPDX-License-Identifier: GPL-2.0-only *//* * SCMI Message Protocol driver header * * Copyright (C) 2018-2021 ARM Ltd. */
#ifndef _LINUX_SCMI_PROTOCOL_H#define _LINUX_SCMI_PROTOCOL_H
#include <linux/bitfield.h>#include <linux/device.h>#include <linux/notifier.h>#include <linux/types.h>
#define SCMI_MAX_STR_SIZE 64#define SCMI_SHORT_NAME_MAX_SIZE 16
/** * struct scmi_base_info - version information structure * * @major_ver: Major ABI version. Change here implies risk of backward * compatibility break. * @minor_ver: Minor ABI version. Change here implies new feature addition, * or compatible change in ABI. * @num_protocols: Number of protocols that are implemented, excluding the * base protocol. * @num_agents: Number of agents in the system. * @impl_ver: A vendor-specific implementation version. * @vendor_id: A vendor identifier(Null terminated ASCII string) * @sub_vendor_id: A sub-vendor identifier(Null terminated ASCII string) */struct scmi_base_info { u16 major_ver; u16 minor_ver; u8 num_protocols; u8 num_agents; u32 impl_ver; char vendor_id[SCMI_SHORT_NAME_MAX_SIZE]; char sub_vendor_id[SCMI_SHORT_NAME_MAX_SIZE];};
struct scmi_clock_rates { bool rate_discrete; unsigned int num_rates; u64 *rates;};
struct scmi_clock_info { char name[SCMI_MAX_STR_SIZE]; unsigned int enable_latency; bool rate_changed_notifications; bool rate_change_requested_notifications; bool state_ctrl_forbidden; bool rate_ctrl_forbidden; bool parent_ctrl_forbidden; bool extended_config; u64 min_rate; u64 max_rate; int num_parents; u32 *parents;};
enum scmi_power_scale { SCMI_POWER_BOGOWATTS, SCMI_POWER_MILLIWATTS, SCMI_POWER_MICROWATTS};
struct scmi_handle;struct scmi_device;struct scmi_protocol_handle;
enum scmi_clock_oem_config { SCMI_CLOCK_CFG_DUTY_CYCLE = 0x1, SCMI_CLOCK_CFG_PHASE, SCMI_CLOCK_CFG_OEM_START = 0x80, SCMI_CLOCK_CFG_OEM_END = 0xFF,};
/** * struct scmi_clk_proto_ops - represents the various operations provided * by SCMI Clock Protocol * * @count_get: get the count of clocks provided by SCMI * @info_get: get the information of the specified clock * @rate_get: request the current clock rate of a clock * @rate_set: set the clock rate of a clock * @determine_rate: determine the effective rate that can be supported by a * clock calculating the closest allowed rate. * Note that @rate is an input/output parameter used both to * describe the requested rate and report the closest match * @all_rates_get: get the list of all available rates for the specified clock. * @enable: enables the specified clock * @disable: disables the specified clock * @state_get: get the status of the specified clock * @config_oem_get: get the value of an OEM specific clock config * @config_oem_set: set the value of an OEM specific clock config * @parent_get: get the parent id of a clk * @parent_set: set the parent of a clock */struct scmi_clk_proto_ops { int (*count_get)(const struct scmi_protocol_handle *ph);
const struct scmi_clock_info __must_check *(*info_get) (const struct scmi_protocol_handle *ph, u32 clk_id); int (*rate_get)(const struct scmi_protocol_handle *ph, u32 clk_id, u64 *rate); int (*rate_set)(const struct scmi_protocol_handle *ph, u32 clk_id, u64 rate); int (*determine_rate)(const struct scmi_protocol_handle *ph, u32 clk_id, unsigned long *rate); const struct scmi_clock_rates __must_check *(*all_rates_get) (const struct scmi_protocol_handle *ph, u32 clk_id); int (*enable)(const struct scmi_protocol_handle *ph, u32 clk_id, bool atomic); int (*disable)(const struct scmi_protocol_handle *ph, u32 clk_id, bool atomic); int (*state_get)(const struct scmi_protocol_handle *ph, u32 clk_id, bool *enabled, bool atomic); int (*config_oem_get)(const struct scmi_protocol_handle *ph, u32 clk_id, enum scmi_clock_oem_config oem_type, u32 *oem_val, u32 *attributes, bool atomic); int (*config_oem_set)(const struct scmi_protocol_handle *ph, u32 clk_id, enum scmi_clock_oem_config oem_type, u32 oem_val, bool atomic); int (*parent_get)(const struct scmi_protocol_handle *ph, u32 clk_id, u32 *parent_id); int (*parent_set)(const struct scmi_protocol_handle *ph, u32 clk_id, u32 parent_id);};
struct scmi_perf_domain_info { char name[SCMI_MAX_STR_SIZE]; bool set_perf;};
/** * struct scmi_perf_proto_ops - represents the various operations provided * by SCMI Performance Protocol * * @num_domains_get: gets the number of supported performance domains * @info_get: get the information of a performance domain * @limits_set: sets limits on the performance level of a domain * @limits_get: gets limits on the performance level of a domain * @level_set: sets the performance level of a domain * @level_get: gets the performance level of a domain * @transition_latency_get: gets the DVFS transition latency for a given device * @rate_limit_get: gets the minimum time (us) required between successive * requests * @device_opps_add: adds all the OPPs for a given device * @freq_set: sets the frequency for a given device using sustained frequency * to sustained performance level mapping * @freq_get: gets the frequency for a given device using sustained frequency * to sustained performance level mapping * @est_power_get: gets the estimated power cost for a given performance domain * at a given frequency * @fast_switch_possible: indicates if fast DVFS switching is possible or not * for a given device * @fast_switch_rate_limit: gets the minimum time (us) required between * successive fast_switching requests * @power_scale_get: indicates if the power values provided are in milliWatts * or in some other (abstract) scale */struct scmi_perf_proto_ops { int (*num_domains_get)(const struct scmi_protocol_handle *ph); const struct scmi_perf_domain_info __must_check *(*info_get) (const struct scmi_protocol_handle *ph, u32 domain); int (*limits_set)(const struct scmi_protocol_handle *ph, u32 domain, u32 max_perf, u32 min_perf); int (*limits_get)(const struct scmi_protocol_handle *ph, u32 domain, u32 *max_perf, u32 *min_perf); int (*level_set)(const struct scmi_protocol_handle *ph, u32 domain, u32 level, bool poll); int (*level_get)(const struct scmi_protocol_handle *ph, u32 domain, u32 *level, bool poll); int (*transition_latency_get)(const struct scmi_protocol_handle *ph, u32 domain); int (*rate_limit_get)(const struct scmi_protocol_handle *ph, u32 domain, u32 *rate_limit); int (*device_opps_add)(const struct scmi_protocol_handle *ph, struct device *dev, u32 domain); int (*freq_set)(const struct scmi_protocol_handle *ph, u32 domain, unsigned long rate, bool poll); int (*freq_get)(const struct scmi_protocol_handle *ph, u32 domain, unsigned long *rate, bool poll); int (*est_power_get)(const struct scmi_protocol_handle *ph, u32 domain, unsigned long *rate, unsigned long *power); bool (*fast_switch_possible)(const struct scmi_protocol_handle *ph, u32 domain); int (*fast_switch_rate_limit)(const struct scmi_protocol_handle *ph, u32 domain, u32 *rate_limit); enum scmi_power_scale (*power_scale_get)(const struct scmi_protocol_handle *ph);};
/** * struct scmi_power_proto_ops - represents the various operations provided * by SCMI Power Protocol * * @num_domains_get: get the count of power domains provided by SCMI * @name_get: gets the name of a power domain * @state_set: sets the power state of a power domain * @state_get: gets the power state of a power domain */struct scmi_power_proto_ops { int (*num_domains_get)(const struct scmi_protocol_handle *ph); const char *(*name_get)(const struct scmi_protocol_handle *ph, u32 domain);#define SCMI_POWER_STATE_TYPE_SHIFT 30#define SCMI_POWER_STATE_ID_MASK (BIT(28) - 1)#define SCMI_POWER_STATE_PARAM(type, id) \ ((((type) & BIT(0)) << SCMI_POWER_STATE_TYPE_SHIFT) | \ ((id) & SCMI_POWER_STATE_ID_MASK))#define SCMI_POWER_STATE_GENERIC_ON SCMI_POWER_STATE_PARAM(0, 0)#define SCMI_POWER_STATE_GENERIC_OFF SCMI_POWER_STATE_PARAM(1, 0) int (*state_set)(const struct scmi_protocol_handle *ph, u32 domain, u32 state); int (*state_get)(const struct scmi_protocol_handle *ph, u32 domain, u32 *state);};
/** * struct scmi_sensor_reading - represent a timestamped read * * Used by @reading_get_timestamped method. * * @value: The signed value sensor read. * @timestamp: An unsigned timestamp for the sensor read, as provided by * SCMI platform. Set to zero when not available. */struct scmi_sensor_reading { long long value; unsigned long long timestamp;};
/** * struct scmi_range_attrs - specifies a sensor or axis values' range * @min_range: The minimum value which can be represented by the sensor/axis. * @max_range: The maximum value which can be represented by the sensor/axis. */struct scmi_range_attrs { long long min_range; long long max_range;};
/** * struct scmi_sensor_axis_info - describes one sensor axes * @id: The axes ID. * @type: Axes type. Chosen amongst one of @enum scmi_sensor_class. * @scale: Power-of-10 multiplier applied to the axis unit. * @name: NULL-terminated string representing axes name as advertised by * SCMI platform. * @extended_attrs: Flag to indicate the presence of additional extended * attributes for this axes. * @resolution: Extended attribute representing the resolution of the axes. * Set to 0 if not reported by this axes. * @exponent: Extended attribute representing the power-of-10 multiplier that * is applied to the resolution field. Set to 0 if not reported by * this axes. * @attrs: Extended attributes representing minimum and maximum values * measurable by this axes. Set to 0 if not reported by this sensor. */struct scmi_sensor_axis_info { unsigned int id; unsigned int type; int scale; char name[SCMI_MAX_STR_SIZE]; bool extended_attrs; unsigned int resolution; int exponent; struct scmi_range_attrs attrs;};
/** * struct scmi_sensor_intervals_info - describes number and type of available * update intervals * @segmented: Flag for segmented intervals' representation. When True there * will be exactly 3 intervals in @desc, with each entry * representing a member of a segment in this order: * {lowest update interval, highest update interval, step size} * @count: Number of intervals described in @desc. * @desc: Array of @count interval descriptor bitmask represented as detailed in * the SCMI specification: it can be accessed using the accompanying * macros. * @prealloc_pool: A minimal preallocated pool of desc entries used to avoid * lesser-than-64-bytes dynamic allocation for small @count * values. */struct scmi_sensor_intervals_info { bool segmented; unsigned int count;#define SCMI_SENS_INTVL_SEGMENT_LOW 0#define SCMI_SENS_INTVL_SEGMENT_HIGH 1#define SCMI_SENS_INTVL_SEGMENT_STEP 2 unsigned int *desc;#define SCMI_SENS_INTVL_GET_SECS(x) FIELD_GET(GENMASK(20, 5), (x))#define SCMI_SENS_INTVL_GET_EXP(x) \ ({ \ int __signed_exp = FIELD_GET(GENMASK(4, 0), (x)); \ \ if (__signed_exp & BIT(4)) \ __signed_exp |= GENMASK(31, 5); \ __signed_exp; \ })#define SCMI_MAX_PREALLOC_POOL 16 unsigned int prealloc_pool[SCMI_MAX_PREALLOC_POOL];};
/** * struct scmi_sensor_info - represents information related to one of the * available sensors. * @id: Sensor ID. * @type: Sensor type. Chosen amongst one of @enum scmi_sensor_class. * @scale: Power-of-10 multiplier applied to the sensor unit. * @num_trip_points: Number of maximum configurable trip points. * @async: Flag for asynchronous read support. * @update: Flag for continuouos update notification support. * @timestamped: Flag for timestamped read support. * @tstamp_scale: Power-of-10 multiplier applied to the sensor timestamps to * represent it in seconds. * @num_axis: Number of supported axis if any. Reported as 0 for scalar sensors. * @axis: Pointer to an array of @num_axis descriptors. * @intervals: Descriptor of available update intervals. * @sensor_config: A bitmask reporting the current sensor configuration as * detailed in the SCMI specification: it can accessed and * modified through the accompanying macros. * @name: NULL-terminated string representing sensor name as advertised by * SCMI platform. * @extended_scalar_attrs: Flag to indicate the presence of additional extended * attributes for this sensor. * @sensor_power: Extended attribute representing the average power * consumed by the sensor in microwatts (uW) when it is active. * Reported here only for scalar sensors. * Set to 0 if not reported by this sensor. * @resolution: Extended attribute representing the resolution of the sensor. * Reported here only for scalar sensors. * Set to 0 if not reported by this sensor. * @exponent: Extended attribute representing the power-of-10 multiplier that is * applied to the resolution field. * Reported here only for scalar sensors. * Set to 0 if not reported by this sensor. * @scalar_attrs: Extended attributes representing minimum and maximum * measurable values by this sensor. * Reported here only for scalar sensors. * Set to 0 if not reported by this sensor. */struct scmi_sensor_info { unsigned int id; unsigned int type; int scale; unsigned int num_trip_points; bool async; bool update; bool timestamped; int tstamp_scale; unsigned int num_axis; struct scmi_sensor_axis_info *axis; struct scmi_sensor_intervals_info intervals; unsigned int sensor_config;#define SCMI_SENS_CFG_UPDATE_SECS_MASK GENMASK(31, 16)#define SCMI_SENS_CFG_GET_UPDATE_SECS(x) \ FIELD_GET(SCMI_SENS_CFG_UPDATE_SECS_MASK, (x))
#define SCMI_SENS_CFG_UPDATE_EXP_MASK GENMASK(15, 11)#define SCMI_SENS_CFG_GET_UPDATE_EXP(x) \ ({ \ int __signed_exp = \ FIELD_GET(SCMI_SENS_CFG_UPDATE_EXP_MASK, (x)); \ \ if (__signed_exp & BIT(4)) \ __signed_exp |= GENMASK(31, 5); \ __signed_exp; \ })
#define SCMI_SENS_CFG_ROUND_MASK GENMASK(10, 9)#define SCMI_SENS_CFG_ROUND_AUTO 2#define SCMI_SENS_CFG_ROUND_UP 1#define SCMI_SENS_CFG_ROUND_DOWN 0
#define SCMI_SENS_CFG_TSTAMP_ENABLED_MASK BIT(1)#define SCMI_SENS_CFG_TSTAMP_ENABLE 1#define SCMI_SENS_CFG_TSTAMP_DISABLE 0#define SCMI_SENS_CFG_IS_TSTAMP_ENABLED(x) \ FIELD_GET(SCMI_SENS_CFG_TSTAMP_ENABLED_MASK, (x))
#define SCMI_SENS_CFG_SENSOR_ENABLED_MASK BIT(0)#define SCMI_SENS_CFG_SENSOR_ENABLE 1#define SCMI_SENS_CFG_SENSOR_DISABLE 0 char name[SCMI_MAX_STR_SIZE];#define SCMI_SENS_CFG_IS_ENABLED(x) FIELD_GET(BIT(0), (x)) bool extended_scalar_attrs; unsigned int sensor_power; unsigned int resolution; int exponent; struct scmi_range_attrs scalar_attrs;};
/* * Partial list from Distributed Management Task Force (DMTF) specification: * DSP0249 (Platform Level Data Model specification) */enum scmi_sensor_class { NONE = 0x0, UNSPEC = 0x1, TEMPERATURE_C = 0x2, TEMPERATURE_F = 0x3, TEMPERATURE_K = 0x4, VOLTAGE = 0x5, CURRENT = 0x6, POWER = 0x7, ENERGY = 0x8, CHARGE = 0x9, VOLTAMPERE = 0xA, NITS = 0xB, LUMENS = 0xC, LUX = 0xD, CANDELAS = 0xE, KPA = 0xF, PSI = 0x10, NEWTON = 0x11, CFM = 0x12, RPM = 0x13, HERTZ = 0x14, SECS = 0x15, MINS = 0x16, HOURS = 0x17, DAYS = 0x18, WEEKS = 0x19, MILS = 0x1A, INCHES = 0x1B, FEET = 0x1C, CUBIC_INCHES = 0x1D, CUBIC_FEET = 0x1E, METERS = 0x1F, CUBIC_CM = 0x20, CUBIC_METERS = 0x21, LITERS = 0x22, FLUID_OUNCES = 0x23, RADIANS = 0x24, STERADIANS = 0x25, REVOLUTIONS = 0x26, CYCLES = 0x27, GRAVITIES = 0x28, OUNCES = 0x29, POUNDS = 0x2A, FOOT_POUNDS = 0x2B, OUNCE_INCHES = 0x2C, GAUSS = 0x2D, GILBERTS = 0x2E, HENRIES = 0x2F, FARADS = 0x30, OHMS = 0x31, SIEMENS = 0x32, MOLES = 0x33, BECQUERELS = 0x34, PPM = 0x35, DECIBELS = 0x36, DBA = 0x37, DBC = 0x38, GRAYS = 0x39, SIEVERTS = 0x3A, COLOR_TEMP_K = 0x3B, BITS = 0x3C, BYTES = 0x3D, WORDS = 0x3E, DWORDS = 0x3F, QWORDS = 0x40, PERCENTAGE = 0x41, PASCALS = 0x42, COUNTS = 0x43, GRAMS = 0x44, NEWTON_METERS = 0x45, HITS = 0x46, MISSES = 0x47, RETRIES = 0x48, OVERRUNS = 0x49, UNDERRUNS = 0x4A, COLLISIONS = 0x4B, PACKETS = 0x4C, MESSAGES = 0x4D, CHARS = 0x4E, ERRORS = 0x4F, CORRECTED_ERRS = 0x50, UNCORRECTABLE_ERRS = 0x51, SQ_MILS = 0x52, SQ_INCHES = 0x53, SQ_FEET = 0x54, SQ_CM = 0x55, SQ_METERS = 0x56, RADIANS_SEC = 0x57, BPM = 0x58, METERS_SEC_SQUARED = 0x59, METERS_SEC = 0x5A, CUBIC_METERS_SEC = 0x5B, MM_MERCURY = 0x5C, RADIANS_SEC_SQUARED = 0x5D, OEM_UNIT = 0xFF};
/** * struct scmi_sensor_proto_ops - represents the various operations provided * by SCMI Sensor Protocol * * @count_get: get the count of sensors provided by SCMI * @info_get: get the information of the specified sensor * @trip_point_config: selects and configures a trip-point of interest * @reading_get: gets the current value of the sensor * @reading_get_timestamped: gets the current value and timestamp, when * available, of the sensor. (as of v3.0 spec) * Supports multi-axis sensors for sensors which * supports it and if the @reading array size of * @count entry equals the sensor num_axis * @config_get: Get sensor current configuration * @config_set: Set sensor current configuration */struct scmi_sensor_proto_ops { int (*count_get)(const struct scmi_protocol_handle *ph); const struct scmi_sensor_info __must_check *(*info_get) (const struct scmi_protocol_handle *ph, u32 sensor_id); int (*trip_point_config)(const struct scmi_protocol_handle *ph, u32 sensor_id, u8 trip_id, u64 trip_value); int (*reading_get)(const struct scmi_protocol_handle *ph, u32 sensor_id, u64 *value); int (*reading_get_timestamped)(const struct scmi_protocol_handle *ph, u32 sensor_id, u8 count, struct scmi_sensor_reading *readings); int (*config_get)(const struct scmi_protocol_handle *ph, u32 sensor_id, u32 *sensor_config); int (*config_set)(const struct scmi_protocol_handle *ph, u32 sensor_id, u32 sensor_config);};
/** * struct scmi_reset_proto_ops - represents the various operations provided * by SCMI Reset Protocol * * @num_domains_get: get the count of reset domains provided by SCMI * @name_get: gets the name of a reset domain * @latency_get: gets the reset latency for the specified reset domain * @reset: resets the specified reset domain * @assert: explicitly assert reset signal of the specified reset domain * @deassert: explicitly deassert reset signal of the specified reset domain */struct scmi_reset_proto_ops { int (*num_domains_get)(const struct scmi_protocol_handle *ph); const char *(*name_get)(const struct scmi_protocol_handle *ph, u32 domain); int (*latency_get)(const struct scmi_protocol_handle *ph, u32 domain); int (*reset)(const struct scmi_protocol_handle *ph, u32 domain); int (*assert)(const struct scmi_protocol_handle *ph, u32 domain); int (*deassert)(const struct scmi_protocol_handle *ph, u32 domain);};
enum scmi_voltage_level_mode { SCMI_VOLTAGE_LEVEL_SET_AUTO, SCMI_VOLTAGE_LEVEL_SET_SYNC,};
/** * struct scmi_voltage_info - describe one available SCMI Voltage Domain * * @id: the domain ID as advertised by the platform * @segmented: defines the layout of the entries of array @levels_uv. * - when True the entries are to be interpreted as triplets, * each defining a segment representing a range of equally * space voltages: <lowest_volts>, <highest_volt>, <step_uV> * - when False the entries simply represent a single discrete * supported voltage level * @negative_volts_allowed: True if any of the entries of @levels_uv represent * a negative voltage. * @async_level_set: True when the voltage domain supports asynchronous level * set commands. * @name: name assigned to the Voltage Domain by platform * @num_levels: number of total entries in @levels_uv. * @levels_uv: array of entries describing the available voltage levels for * this domain. */struct scmi_voltage_info { unsigned int id; bool segmented; bool negative_volts_allowed; bool async_level_set; char name[SCMI_MAX_STR_SIZE]; unsigned int num_levels;#define SCMI_VOLTAGE_SEGMENT_LOW 0#define SCMI_VOLTAGE_SEGMENT_HIGH 1#define SCMI_VOLTAGE_SEGMENT_STEP 2 int *levels_uv;};
/** * struct scmi_voltage_proto_ops - represents the various operations provided * by SCMI Voltage Protocol * * @num_domains_get: get the count of voltage domains provided by SCMI * @info_get: get the information of the specified domain * @config_set: set the config for the specified domain * @config_get: get the config of the specified domain * @level_set: set the voltage level for the specified domain * @level_get: get the voltage level of the specified domain */struct scmi_voltage_proto_ops { int (*num_domains_get)(const struct scmi_protocol_handle *ph); const struct scmi_voltage_info __must_check *(*info_get) (const struct scmi_protocol_handle *ph, u32 domain_id); int (*config_set)(const struct scmi_protocol_handle *ph, u32 domain_id, u32 config);#define SCMI_VOLTAGE_ARCH_STATE_OFF 0x0#define SCMI_VOLTAGE_ARCH_STATE_ON 0x7 int (*config_get)(const struct scmi_protocol_handle *ph, u32 domain_id, u32 *config); int (*level_set)(const struct scmi_protocol_handle *ph, u32 domain_id, enum scmi_voltage_level_mode mode, s32 volt_uV); int (*level_get)(const struct scmi_protocol_handle *ph, u32 domain_id, s32 *volt_uV);};
/** * struct scmi_powercap_info - Describe one available Powercap domain * * @id: Domain ID as advertised by the platform. * @notify_powercap_cap_change: CAP change notification support. * @notify_powercap_measurement_change: MEASUREMENTS change notifications * support. * @async_powercap_cap_set: Asynchronous CAP set support. * @powercap_cap_config: CAP configuration support. * @powercap_monitoring: Monitoring (measurements) support. * @powercap_pai_config: PAI configuration support. * @powercap_scale_mw: Domain reports power data in milliwatt units. * @powercap_scale_uw: Domain reports power data in microwatt units. * Note that, when both @powercap_scale_mw and * @powercap_scale_uw are set to false, the domain * reports power data on an abstract linear scale. * @name: name assigned to the Powercap Domain by platform. * @min_pai: Minimum configurable PAI. * @max_pai: Maximum configurable PAI. * @pai_step: Step size between two consecutive PAI values. * @min_power_cap: Minimum configurable CAP. * @max_power_cap: Maximum configurable CAP. * @power_cap_step: Step size between two consecutive CAP values. * @sustainable_power: Maximum sustainable power consumption for this domain * under normal conditions. * @accuracy: The accuracy with which the power is measured and reported in * integral multiples of 0.001 percent. * @parent_id: Identifier of the containing parent power capping domain, or the * value 0xFFFFFFFF if this powercap domain is a root domain not * contained in any other domain. */struct scmi_powercap_info { unsigned int id; bool notify_powercap_cap_change; bool notify_powercap_measurement_change; bool async_powercap_cap_set; bool powercap_cap_config; bool powercap_monitoring; bool powercap_pai_config; bool powercap_scale_mw; bool powercap_scale_uw; bool fastchannels; char name[SCMI_MAX_STR_SIZE]; unsigned int min_pai; unsigned int max_pai; unsigned int pai_step; unsigned int min_power_cap; unsigned int max_power_cap; unsigned int power_cap_step; unsigned int sustainable_power; unsigned int accuracy;#define SCMI_POWERCAP_ROOT_ZONE_ID 0xFFFFFFFFUL unsigned int parent_id; struct scmi_fc_info *fc_info;};
/** * struct scmi_powercap_proto_ops - represents the various operations provided * by SCMI Powercap Protocol * * @num_domains_get: get the count of powercap domains provided by SCMI. * @info_get: get the information for the specified domain. * @cap_get: get the current CAP value for the specified domain. * On SCMI platforms supporting powercap zone disabling, this could * report a zero value for a zone where powercapping is disabled. * @cap_set: set the CAP value for the specified domain to the provided value; * if the domain supports setting the CAP with an asynchronous command * this request will finally trigger an asynchronous transfer, but, if * @ignore_dresp here is set to true, this call will anyway return * immediately without waiting for the related delayed response. * Note that the powercap requested value must NOT be zero, even if * the platform supports disabling a powercap by setting its cap to * zero (since SCMI v3.2): there are dedicated operations that should * be used for that. (@cap_enable_set/get) * @cap_enable_set: enable or disable the powercapping on the specified domain, * if supported by the SCMI platform implementation. * Note that, by the SCMI specification, the platform can * silently ignore our disable request and decide to enforce * anyway some other powercap value requested by another agent * on the system: for this reason @cap_get and @cap_enable_get * will always report the final platform view of the powercaps. * @cap_enable_get: get the current CAP enable status for the specified domain. * @pai_get: get the current PAI value for the specified domain. * @pai_set: set the PAI value for the specified domain to the provided value. * @measurements_get: retrieve the current average power measurements for the * specified domain and the related PAI upon which is * calculated. * @measurements_threshold_set: set the desired low and high power thresholds * to be used when registering for notification * of type POWERCAP_MEASUREMENTS_NOTIFY with this * powercap domain. * Note that this must be called at least once * before registering any callback with the usual * @scmi_notify_ops; moreover, in case this method * is called with measurement notifications already * enabled it will also trigger, transparently, a * proper update of the power thresholds configured * in the SCMI backend server. * @measurements_threshold_get: get the currently configured low and high power * thresholds used when registering callbacks for * notification POWERCAP_MEASUREMENTS_NOTIFY. */struct scmi_powercap_proto_ops { int (*num_domains_get)(const struct scmi_protocol_handle *ph); const struct scmi_powercap_info __must_check *(*info_get) (const struct scmi_protocol_handle *ph, u32 domain_id); int (*cap_get)(const struct scmi_protocol_handle *ph, u32 domain_id, u32 *power_cap); int (*cap_set)(const struct scmi_protocol_handle *ph, u32 domain_id, u32 power_cap, bool ignore_dresp); int (*cap_enable_set)(const struct scmi_protocol_handle *ph, u32 domain_id, bool enable); int (*cap_enable_get)(const struct scmi_protocol_handle *ph, u32 domain_id, bool *enable); int (*pai_get)(const struct scmi_protocol_handle *ph, u32 domain_id, u32 *pai); int (*pai_set)(const struct scmi_protocol_handle *ph, u32 domain_id, u32 pai); int (*measurements_get)(const struct scmi_protocol_handle *ph, u32 domain_id, u32 *average_power, u32 *pai); int (*measurements_threshold_set)(const struct scmi_protocol_handle *ph, u32 domain_id, u32 power_thresh_low, u32 power_thresh_high); int (*measurements_threshold_get)(const struct scmi_protocol_handle *ph, u32 domain_id, u32 *power_thresh_low, u32 *power_thresh_high);};
enum scmi_pinctrl_selector_type { PIN_TYPE = 0, GROUP_TYPE, FUNCTION_TYPE,};
enum scmi_pinctrl_conf_type { SCMI_PIN_DEFAULT = 0, SCMI_PIN_BIAS_BUS_HOLD = 1, SCMI_PIN_BIAS_DISABLE = 2, SCMI_PIN_BIAS_HIGH_IMPEDANCE = 3, SCMI_PIN_BIAS_PULL_UP = 4, SCMI_PIN_BIAS_PULL_DEFAULT = 5, SCMI_PIN_BIAS_PULL_DOWN = 6, SCMI_PIN_DRIVE_OPEN_DRAIN = 7, SCMI_PIN_DRIVE_OPEN_SOURCE = 8, SCMI_PIN_DRIVE_PUSH_PULL = 9, SCMI_PIN_DRIVE_STRENGTH = 10, SCMI_PIN_INPUT_DEBOUNCE = 11, SCMI_PIN_INPUT_MODE = 12, SCMI_PIN_PULL_MODE = 13, SCMI_PIN_INPUT_VALUE = 14, SCMI_PIN_INPUT_SCHMITT = 15, SCMI_PIN_LOW_POWER_MODE = 16, SCMI_PIN_OUTPUT_MODE = 17, SCMI_PIN_OUTPUT_VALUE = 18, SCMI_PIN_POWER_SOURCE = 19, SCMI_PIN_SLEW_RATE = 20, SCMI_PIN_OEM_START = 192, SCMI_PIN_OEM_END = 255,};
/** * struct scmi_pinctrl_proto_ops - represents the various operations provided * by SCMI Pinctrl Protocol * * @count_get: returns count of the registered elements in given type * @name_get: returns name by index of given type * @group_pins_get: returns the set of pins, assigned to the specified group * @function_groups_get: returns the set of groups, assigned to the specified * function * @mux_set: set muxing function for groups of pins * @settings_get_one: returns one configuration parameter for pin or group * specified by config_type * @settings_get_all: returns all configuration parameters for pin or group * @settings_conf: sets the configuration parameter for pin or group * @pin_request: aquire pin before selecting mux setting * @pin_free: frees pin, acquired by request_pin call */struct scmi_pinctrl_proto_ops { int (*count_get)(const struct scmi_protocol_handle *ph, enum scmi_pinctrl_selector_type type); int (*name_get)(const struct scmi_protocol_handle *ph, u32 selector, enum scmi_pinctrl_selector_type type, const char **name); int (*group_pins_get)(const struct scmi_protocol_handle *ph, u32 selector, const unsigned int **pins, unsigned int *nr_pins); int (*function_groups_get)(const struct scmi_protocol_handle *ph, u32 selector, unsigned int *nr_groups, const unsigned int **groups); int (*mux_set)(const struct scmi_protocol_handle *ph, u32 selector, u32 group); int (*settings_get_one)(const struct scmi_protocol_handle *ph, u32 selector, enum scmi_pinctrl_selector_type type, enum scmi_pinctrl_conf_type config_type, u32 *config_value); int (*settings_get_all)(const struct scmi_protocol_handle *ph, u32 selector, enum scmi_pinctrl_selector_type type, unsigned int *nr_configs, enum scmi_pinctrl_conf_type *config_types, u32 *config_values); int (*settings_conf)(const struct scmi_protocol_handle *ph, u32 selector, enum scmi_pinctrl_selector_type type, unsigned int nr_configs, enum scmi_pinctrl_conf_type *config_type, u32 *config_value); int (*pin_request)(const struct scmi_protocol_handle *ph, u32 pin); int (*pin_free)(const struct scmi_protocol_handle *ph, u32 pin);};
/** * struct scmi_notify_ops - represents notifications' operations provided by * SCMI core * @devm_event_notifier_register: Managed registration of a notifier_block for * the requested event * @devm_event_notifier_unregister: Managed unregistration of a notifier_block * for the requested event * @event_notifier_register: Register a notifier_block for the requested event * @event_notifier_unregister: Unregister a notifier_block for the requested * event * * A user can register/unregister its own notifier_block against the wanted * platform instance regarding the desired event identified by the * tuple: (proto_id, evt_id, src_id) using the provided register/unregister * interface where: * * @sdev: The scmi_device to use when calling the devres managed ops devm_ * @handle: The handle identifying the platform instance to use, when not * calling the managed ops devm_ * @proto_id: The protocol ID as in SCMI Specification * @evt_id: The message ID of the desired event as in SCMI Specification * @src_id: A pointer to the desired source ID if different sources are * possible for the protocol (like domain_id, sensor_id...etc) * * @src_id can be provided as NULL if it simply does NOT make sense for * the protocol at hand, OR if the user is explicitly interested in * receiving notifications from ANY existent source associated to the * specified proto_id / evt_id. * * Received notifications are finally delivered to the registered users, * invoking the callback provided with the notifier_block *nb as follows: * * int user_cb(nb, evt_id, report) * * with: * * @nb: The notifier block provided by the user * @evt_id: The message ID of the delivered event * @report: A custom struct describing the specific event delivered */struct scmi_notify_ops { int (*devm_event_notifier_register)(struct scmi_device *sdev, u8 proto_id, u8 evt_id, const u32 *src_id, struct notifier_block *nb); int (*devm_event_notifier_unregister)(struct scmi_device *sdev, struct notifier_block *nb); int (*event_notifier_register)(const struct scmi_handle *handle, u8 proto_id, u8 evt_id, const u32 *src_id, struct notifier_block *nb); int (*event_notifier_unregister)(const struct scmi_handle *handle, u8 proto_id, u8 evt_id, const u32 *src_id, struct notifier_block *nb);};
/** * struct scmi_handle - Handle returned to ARM SCMI clients for usage. * * @dev: pointer to the SCMI device * @version: pointer to the structure containing SCMI version information * @devm_protocol_acquire: devres managed method to get hold of a protocol, * causing its initialization and related resource * accounting * @devm_protocol_get: devres managed method to acquire a protocol and get specific * operations and a dedicated protocol handler * @devm_protocol_put: devres managed method to release a protocol * @is_transport_atomic: method to check if the underlying transport for this * instance handle is configured to support atomic * transactions for commands. * Some users of the SCMI stack in the upper layers could * be interested to know if they can assume SCMI * command transactions associated to this handle will * never sleep and act accordingly. * An optional atomic threshold value could be returned * where configured. * @notify_ops: pointer to set of notifications related operations */struct scmi_handle { struct device *dev; struct scmi_base_info *version;
int __must_check (*devm_protocol_acquire)(struct scmi_device *sdev, u8 proto); const void __must_check * (*devm_protocol_get)(struct scmi_device *sdev, u8 proto, struct scmi_protocol_handle **ph); void (*devm_protocol_put)(struct scmi_device *sdev, u8 proto); bool (*is_transport_atomic)(const struct scmi_handle *handle, unsigned int *atomic_threshold);
const struct scmi_notify_ops *notify_ops;};
enum scmi_std_protocol { SCMI_PROTOCOL_BASE = 0x10, SCMI_PROTOCOL_POWER = 0x11, SCMI_PROTOCOL_SYSTEM = 0x12, SCMI_PROTOCOL_PERF = 0x13, SCMI_PROTOCOL_CLOCK = 0x14, SCMI_PROTOCOL_SENSOR = 0x15, SCMI_PROTOCOL_RESET = 0x16, SCMI_PROTOCOL_VOLTAGE = 0x17, SCMI_PROTOCOL_POWERCAP = 0x18, SCMI_PROTOCOL_PINCTRL = 0x19,};
enum scmi_system_events { SCMI_SYSTEM_SHUTDOWN, SCMI_SYSTEM_COLDRESET, SCMI_SYSTEM_WARMRESET, SCMI_SYSTEM_POWERUP, SCMI_SYSTEM_SUSPEND, SCMI_SYSTEM_MAX};
struct scmi_device { u32 id; u8 protocol_id; const char *name; struct device dev; struct scmi_handle *handle;};
#define to_scmi_dev(d) container_of_const(d, struct scmi_device, dev)
struct scmi_device_id { u8 protocol_id; const char *name;};
struct scmi_driver { const char *name; int (*probe)(struct scmi_device *sdev); void (*remove)(struct scmi_device *sdev); const struct scmi_device_id *id_table;
struct device_driver driver;};
#define to_scmi_driver(d) container_of(d, struct scmi_driver, driver)
#if IS_REACHABLE(CONFIG_ARM_SCMI_PROTOCOL)int scmi_driver_register(struct scmi_driver *driver, struct module *owner, const char *mod_name);void scmi_driver_unregister(struct scmi_driver *driver);#elsestatic inline intscmi_driver_register(struct scmi_driver *driver, struct module *owner, const char *mod_name){ return -EINVAL;}
static inline void scmi_driver_unregister(struct scmi_driver *driver) {}#endif /* CONFIG_ARM_SCMI_PROTOCOL */
#define scmi_register(driver) \ scmi_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)#define scmi_unregister(driver) \ scmi_driver_unregister(driver)
/** * module_scmi_driver() - Helper macro for registering a scmi driver * @__scmi_driver: scmi_driver structure * * Helper macro for scmi drivers to set up proper module init / exit * functions. Replaces module_init() and module_exit() and keeps people from * printing pointless things to the kernel log when their driver is loaded. */#define module_scmi_driver(__scmi_driver) \ module_driver(__scmi_driver, scmi_register, scmi_unregister)
/** * module_scmi_protocol() - Helper macro for registering a scmi protocol * @__scmi_protocol: scmi_protocol structure * * Helper macro for scmi drivers to set up proper module init / exit * functions. Replaces module_init() and module_exit() and keeps people from * printing pointless things to the kernel log when their driver is loaded. */#define module_scmi_protocol(__scmi_protocol) \ module_driver(__scmi_protocol, \ scmi_protocol_register, scmi_protocol_unregister)
struct scmi_protocol;int scmi_protocol_register(const struct scmi_protocol *proto);void scmi_protocol_unregister(const struct scmi_protocol *proto);
/* SCMI Notification API - Custom Event Reports */enum scmi_notification_events { SCMI_EVENT_POWER_STATE_CHANGED = 0x0, SCMI_EVENT_CLOCK_RATE_CHANGED = 0x0, SCMI_EVENT_CLOCK_RATE_CHANGE_REQUESTED = 0x1, SCMI_EVENT_PERFORMANCE_LIMITS_CHANGED = 0x0, SCMI_EVENT_PERFORMANCE_LEVEL_CHANGED = 0x1, SCMI_EVENT_SENSOR_TRIP_POINT_EVENT = 0x0, SCMI_EVENT_SENSOR_UPDATE = 0x1, SCMI_EVENT_RESET_ISSUED = 0x0, SCMI_EVENT_BASE_ERROR_EVENT = 0x0, SCMI_EVENT_SYSTEM_POWER_STATE_NOTIFIER = 0x0, SCMI_EVENT_POWERCAP_CAP_CHANGED = 0x0, SCMI_EVENT_POWERCAP_MEASUREMENTS_CHANGED = 0x1,};
struct scmi_power_state_changed_report { ktime_t timestamp; unsigned int agent_id; unsigned int domain_id; unsigned int power_state;};
struct scmi_clock_rate_notif_report { ktime_t timestamp; unsigned int agent_id; unsigned int clock_id; unsigned long long rate;};
struct scmi_system_power_state_notifier_report { ktime_t timestamp; unsigned int agent_id;#define SCMI_SYSPOWER_IS_REQUEST_GRACEFUL(flags) ((flags) & BIT(0)) unsigned int flags; unsigned int system_state; unsigned int timeout;};
struct scmi_perf_limits_report { ktime_t timestamp; unsigned int agent_id; unsigned int domain_id; unsigned int range_max; unsigned int range_min; unsigned long range_max_freq; unsigned long range_min_freq;};
struct scmi_perf_level_report { ktime_t timestamp; unsigned int agent_id; unsigned int domain_id; unsigned int performance_level; unsigned long performance_level_freq;};
struct scmi_sensor_trip_point_report { ktime_t timestamp; unsigned int agent_id; unsigned int sensor_id; unsigned int trip_point_desc;};
struct scmi_sensor_update_report { ktime_t timestamp; unsigned int agent_id; unsigned int sensor_id; unsigned int readings_count; struct scmi_sensor_reading readings[];};
struct scmi_reset_issued_report { ktime_t timestamp; unsigned int agent_id; unsigned int domain_id; unsigned int reset_state;};
struct scmi_base_error_report { ktime_t timestamp; unsigned int agent_id; bool fatal; unsigned int cmd_count; unsigned long long reports[];};
struct scmi_powercap_cap_changed_report { ktime_t timestamp; unsigned int agent_id; unsigned int domain_id; unsigned int power_cap; unsigned int pai;};
struct scmi_powercap_meas_changed_report { ktime_t timestamp; unsigned int agent_id; unsigned int domain_id; unsigned int power;};#endif /* _LINUX_SCMI_PROTOCOL_H */