14752544aSSudeep Holla /* SPDX-License-Identifier: GPL-2.0-only */ 2aa4f886fSSudeep Holla /* 3aa4f886fSSudeep Holla * SCMI Message Protocol driver header 4aa4f886fSSudeep Holla * 548dc16e2SCristian Marussi * Copyright (C) 2018-2021 ARM Ltd. 6aa4f886fSSudeep Holla */ 770771c69SSudeep Holla 870771c69SSudeep Holla #ifndef _LINUX_SCMI_PROTOCOL_H 970771c69SSudeep Holla #define _LINUX_SCMI_PROTOCOL_H 1070771c69SSudeep Holla 111fe00b8bSCristian Marussi #include <linux/bitfield.h> 12933c5044SSudeep Holla #include <linux/device.h> 13e7c215f3SCristian Marussi #include <linux/notifier.h> 14aa4f886fSSudeep Holla #include <linux/types.h> 15aa4f886fSSudeep Holla 16b260fccaSCristian Marussi #define SCMI_MAX_STR_SIZE 64 174314f9f4SCristian Marussi #define SCMI_SHORT_NAME_MAX_SIZE 16 185f6c6430SSudeep Holla #define SCMI_MAX_NUM_RATES 16 19b6f20ff8SSudeep Holla 20b6f20ff8SSudeep Holla /** 21b6f20ff8SSudeep Holla * struct scmi_revision_info - version information structure 22b6f20ff8SSudeep Holla * 23b6f20ff8SSudeep Holla * @major_ver: Major ABI version. Change here implies risk of backward 24b6f20ff8SSudeep Holla * compatibility break. 25b6f20ff8SSudeep Holla * @minor_ver: Minor ABI version. Change here implies new feature addition, 26b6f20ff8SSudeep Holla * or compatible change in ABI. 27b6f20ff8SSudeep Holla * @num_protocols: Number of protocols that are implemented, excluding the 28b6f20ff8SSudeep Holla * base protocol. 29b6f20ff8SSudeep Holla * @num_agents: Number of agents in the system. 30b6f20ff8SSudeep Holla * @impl_ver: A vendor-specific implementation version. 31b6f20ff8SSudeep Holla * @vendor_id: A vendor identifier(Null terminated ASCII string) 32b6f20ff8SSudeep Holla * @sub_vendor_id: A sub-vendor identifier(Null terminated ASCII string) 33b6f20ff8SSudeep Holla */ 34b6f20ff8SSudeep Holla struct scmi_revision_info { 35b6f20ff8SSudeep Holla u16 major_ver; 36b6f20ff8SSudeep Holla u16 minor_ver; 37b6f20ff8SSudeep Holla u8 num_protocols; 38b6f20ff8SSudeep Holla u8 num_agents; 39b6f20ff8SSudeep Holla u32 impl_ver; 404314f9f4SCristian Marussi char vendor_id[SCMI_SHORT_NAME_MAX_SIZE]; 414314f9f4SCristian Marussi char sub_vendor_id[SCMI_SHORT_NAME_MAX_SIZE]; 42b6f20ff8SSudeep Holla }; 43b6f20ff8SSudeep Holla 445f6c6430SSudeep Holla struct scmi_clock_info { 455f6c6430SSudeep Holla char name[SCMI_MAX_STR_SIZE]; 4618f295b7SCristian Marussi unsigned int enable_latency; 475f6c6430SSudeep Holla bool rate_discrete; 487aa75496SCristian Marussi bool rate_changed_notifications; 497aa75496SCristian Marussi bool rate_change_requested_notifications; 505f6c6430SSudeep Holla union { 515f6c6430SSudeep Holla struct { 525f6c6430SSudeep Holla int num_rates; 535f6c6430SSudeep Holla u64 rates[SCMI_MAX_NUM_RATES]; 545f6c6430SSudeep Holla } list; 555f6c6430SSudeep Holla struct { 565f6c6430SSudeep Holla u64 min_rate; 575f6c6430SSudeep Holla u64 max_rate; 585f6c6430SSudeep Holla u64 step_size; 595f6c6430SSudeep Holla } range; 605f6c6430SSudeep Holla }; 615f6c6430SSudeep Holla }; 625f6c6430SSudeep Holla 63a9e3fbfaSSudeep Holla struct scmi_handle; 6423934efeSCristian Marussi struct scmi_device; 6523934efeSCristian Marussi struct scmi_protocol_handle; 66a9e3fbfaSSudeep Holla 67a9e3fbfaSSudeep Holla /** 68887281c7SCristian Marussi * struct scmi_clk_proto_ops - represents the various operations provided 695f6c6430SSudeep Holla * by SCMI Clock Protocol 705f6c6430SSudeep Holla * 715f6c6430SSudeep Holla * @count_get: get the count of clocks provided by SCMI 725f6c6430SSudeep Holla * @info_get: get the information of the specified clock 735f6c6430SSudeep Holla * @rate_get: request the current clock rate of a clock 745f6c6430SSudeep Holla * @rate_set: set the clock rate of a clock 755f6c6430SSudeep Holla * @enable: enables the specified clock 765f6c6430SSudeep Holla * @disable: disables the specified clock 775f6c6430SSudeep Holla */ 78887281c7SCristian Marussi struct scmi_clk_proto_ops { 79887281c7SCristian Marussi int (*count_get)(const struct scmi_protocol_handle *ph); 80887281c7SCristian Marussi 81887281c7SCristian Marussi const struct scmi_clock_info *(*info_get) 82887281c7SCristian Marussi (const struct scmi_protocol_handle *ph, u32 clk_id); 83887281c7SCristian Marussi int (*rate_get)(const struct scmi_protocol_handle *ph, u32 clk_id, 84887281c7SCristian Marussi u64 *rate); 85887281c7SCristian Marussi int (*rate_set)(const struct scmi_protocol_handle *ph, u32 clk_id, 86887281c7SCristian Marussi u64 rate); 87887281c7SCristian Marussi int (*enable)(const struct scmi_protocol_handle *ph, u32 clk_id); 88887281c7SCristian Marussi int (*disable)(const struct scmi_protocol_handle *ph, u32 clk_id); 89b7bd36f2SCristian Marussi int (*enable_atomic)(const struct scmi_protocol_handle *ph, u32 clk_id); 90b7bd36f2SCristian Marussi int (*disable_atomic)(const struct scmi_protocol_handle *ph, 91b7bd36f2SCristian Marussi u32 clk_id); 92887281c7SCristian Marussi }; 93887281c7SCristian Marussi 945f6c6430SSudeep Holla /** 951fec5e6bSCristian Marussi * struct scmi_perf_proto_ops - represents the various operations provided 96a9e3fbfaSSudeep Holla * by SCMI Performance Protocol 97a9e3fbfaSSudeep Holla * 98a9e3fbfaSSudeep Holla * @limits_set: sets limits on the performance level of a domain 99a9e3fbfaSSudeep Holla * @limits_get: gets limits on the performance level of a domain 100a9e3fbfaSSudeep Holla * @level_set: sets the performance level of a domain 101a9e3fbfaSSudeep Holla * @level_get: gets the performance level of a domain 102a9e3fbfaSSudeep Holla * @device_domain_id: gets the scmi domain id for a given device 1037859e08cSSudeep Holla * @transition_latency_get: gets the DVFS transition latency for a given device 1047859e08cSSudeep Holla * @device_opps_add: adds all the OPPs for a given device 105a9e3fbfaSSudeep Holla * @freq_set: sets the frequency for a given device using sustained frequency 106a9e3fbfaSSudeep Holla * to sustained performance level mapping 107a9e3fbfaSSudeep Holla * @freq_get: gets the frequency for a given device using sustained frequency 108a9e3fbfaSSudeep Holla * to sustained performance level mapping 1091a63fe9aSQuentin Perret * @est_power_get: gets the estimated power cost for a given performance domain 1101a63fe9aSQuentin Perret * at a given frequency 11152f83955SSudeep Holla * @fast_switch_possible: indicates if fast DVFS switching is possible or not 11252f83955SSudeep Holla * for a given device 11352f83955SSudeep Holla * @power_scale_mw_get: indicates if the power values provided are in milliWatts 11452f83955SSudeep Holla * or in some other (abstract) scale 115a9e3fbfaSSudeep Holla */ 1161fec5e6bSCristian Marussi struct scmi_perf_proto_ops { 1171fec5e6bSCristian Marussi int (*limits_set)(const struct scmi_protocol_handle *ph, u32 domain, 1181fec5e6bSCristian Marussi u32 max_perf, u32 min_perf); 1191fec5e6bSCristian Marussi int (*limits_get)(const struct scmi_protocol_handle *ph, u32 domain, 1201fec5e6bSCristian Marussi u32 *max_perf, u32 *min_perf); 1211fec5e6bSCristian Marussi int (*level_set)(const struct scmi_protocol_handle *ph, u32 domain, 1221fec5e6bSCristian Marussi u32 level, bool poll); 1231fec5e6bSCristian Marussi int (*level_get)(const struct scmi_protocol_handle *ph, u32 domain, 1241fec5e6bSCristian Marussi u32 *level, bool poll); 1251fec5e6bSCristian Marussi int (*device_domain_id)(struct device *dev); 1261fec5e6bSCristian Marussi int (*transition_latency_get)(const struct scmi_protocol_handle *ph, 1271fec5e6bSCristian Marussi struct device *dev); 1281fec5e6bSCristian Marussi int (*device_opps_add)(const struct scmi_protocol_handle *ph, 1291fec5e6bSCristian Marussi struct device *dev); 1301fec5e6bSCristian Marussi int (*freq_set)(const struct scmi_protocol_handle *ph, u32 domain, 1311fec5e6bSCristian Marussi unsigned long rate, bool poll); 1321fec5e6bSCristian Marussi int (*freq_get)(const struct scmi_protocol_handle *ph, u32 domain, 1331fec5e6bSCristian Marussi unsigned long *rate, bool poll); 1341fec5e6bSCristian Marussi int (*est_power_get)(const struct scmi_protocol_handle *ph, u32 domain, 1351fec5e6bSCristian Marussi unsigned long *rate, unsigned long *power); 1361fec5e6bSCristian Marussi bool (*fast_switch_possible)(const struct scmi_protocol_handle *ph, 1371fec5e6bSCristian Marussi struct device *dev); 1381fec5e6bSCristian Marussi bool (*power_scale_mw_get)(const struct scmi_protocol_handle *ph); 1391fec5e6bSCristian Marussi }; 1401fec5e6bSCristian Marussi 141aa4f886fSSudeep Holla /** 1429bc8069cSCristian Marussi * struct scmi_power_proto_ops - represents the various operations provided 14376a65509SSudeep Holla * by SCMI Power Protocol 14476a65509SSudeep Holla * 14576a65509SSudeep Holla * @num_domains_get: get the count of power domains provided by SCMI 14676a65509SSudeep Holla * @name_get: gets the name of a power domain 14776a65509SSudeep Holla * @state_set: sets the power state of a power domain 14876a65509SSudeep Holla * @state_get: gets the power state of a power domain 14976a65509SSudeep Holla */ 1509bc8069cSCristian Marussi struct scmi_power_proto_ops { 1519bc8069cSCristian Marussi int (*num_domains_get)(const struct scmi_protocol_handle *ph); 152992be5d3SCristian Marussi const char *(*name_get)(const struct scmi_protocol_handle *ph, 153992be5d3SCristian Marussi u32 domain); 15476a65509SSudeep Holla #define SCMI_POWER_STATE_TYPE_SHIFT 30 15576a65509SSudeep Holla #define SCMI_POWER_STATE_ID_MASK (BIT(28) - 1) 15676a65509SSudeep Holla #define SCMI_POWER_STATE_PARAM(type, id) \ 15776a65509SSudeep Holla ((((type) & BIT(0)) << SCMI_POWER_STATE_TYPE_SHIFT) | \ 15876a65509SSudeep Holla ((id) & SCMI_POWER_STATE_ID_MASK)) 15976a65509SSudeep Holla #define SCMI_POWER_STATE_GENERIC_ON SCMI_POWER_STATE_PARAM(0, 0) 16076a65509SSudeep Holla #define SCMI_POWER_STATE_GENERIC_OFF SCMI_POWER_STATE_PARAM(1, 0) 1619bc8069cSCristian Marussi int (*state_set)(const struct scmi_protocol_handle *ph, u32 domain, 1629bc8069cSCristian Marussi u32 state); 1639bc8069cSCristian Marussi int (*state_get)(const struct scmi_protocol_handle *ph, u32 domain, 1649bc8069cSCristian Marussi u32 *state); 1659bc8069cSCristian Marussi }; 1669bc8069cSCristian Marussi 1671fe00b8bSCristian Marussi /** 16852f83955SSudeep Holla * struct scmi_sensor_reading - represent a timestamped read 169e2083d36SCristian Marussi * 170e2083d36SCristian Marussi * Used by @reading_get_timestamped method. 171e2083d36SCristian Marussi * 172e2083d36SCristian Marussi * @value: The signed value sensor read. 173e2083d36SCristian Marussi * @timestamp: An unsigned timestamp for the sensor read, as provided by 174e2083d36SCristian Marussi * SCMI platform. Set to zero when not available. 175e2083d36SCristian Marussi */ 176e2083d36SCristian Marussi struct scmi_sensor_reading { 177e2083d36SCristian Marussi long long value; 178e2083d36SCristian Marussi unsigned long long timestamp; 179e2083d36SCristian Marussi }; 180e2083d36SCristian Marussi 181e2083d36SCristian Marussi /** 18252f83955SSudeep Holla * struct scmi_range_attrs - specifies a sensor or axis values' range 1831fe00b8bSCristian Marussi * @min_range: The minimum value which can be represented by the sensor/axis. 1841fe00b8bSCristian Marussi * @max_range: The maximum value which can be represented by the sensor/axis. 1851fe00b8bSCristian Marussi */ 1861fe00b8bSCristian Marussi struct scmi_range_attrs { 1871fe00b8bSCristian Marussi long long min_range; 1881fe00b8bSCristian Marussi long long max_range; 1891fe00b8bSCristian Marussi }; 1901fe00b8bSCristian Marussi 1911fe00b8bSCristian Marussi /** 19252f83955SSudeep Holla * struct scmi_sensor_axis_info - describes one sensor axes 1931fe00b8bSCristian Marussi * @id: The axes ID. 1941fe00b8bSCristian Marussi * @type: Axes type. Chosen amongst one of @enum scmi_sensor_class. 1951fe00b8bSCristian Marussi * @scale: Power-of-10 multiplier applied to the axis unit. 1961fe00b8bSCristian Marussi * @name: NULL-terminated string representing axes name as advertised by 1971fe00b8bSCristian Marussi * SCMI platform. 1981fe00b8bSCristian Marussi * @extended_attrs: Flag to indicate the presence of additional extended 1991fe00b8bSCristian Marussi * attributes for this axes. 2001fe00b8bSCristian Marussi * @resolution: Extended attribute representing the resolution of the axes. 2011fe00b8bSCristian Marussi * Set to 0 if not reported by this axes. 2021fe00b8bSCristian Marussi * @exponent: Extended attribute representing the power-of-10 multiplier that 2031fe00b8bSCristian Marussi * is applied to the resolution field. Set to 0 if not reported by 2041fe00b8bSCristian Marussi * this axes. 2051fe00b8bSCristian Marussi * @attrs: Extended attributes representing minimum and maximum values 2061fe00b8bSCristian Marussi * measurable by this axes. Set to 0 if not reported by this sensor. 2071fe00b8bSCristian Marussi */ 2081fe00b8bSCristian Marussi struct scmi_sensor_axis_info { 2091fe00b8bSCristian Marussi unsigned int id; 2101fe00b8bSCristian Marussi unsigned int type; 2111fe00b8bSCristian Marussi int scale; 2125179c523SSudeep Holla char name[SCMI_MAX_STR_SIZE]; 2131fe00b8bSCristian Marussi bool extended_attrs; 2141fe00b8bSCristian Marussi unsigned int resolution; 2151fe00b8bSCristian Marussi int exponent; 2161fe00b8bSCristian Marussi struct scmi_range_attrs attrs; 2171fe00b8bSCristian Marussi }; 2181fe00b8bSCristian Marussi 2191fe00b8bSCristian Marussi /** 22052f83955SSudeep Holla * struct scmi_sensor_intervals_info - describes number and type of available 22152f83955SSudeep Holla * update intervals 2221fe00b8bSCristian Marussi * @segmented: Flag for segmented intervals' representation. When True there 2231fe00b8bSCristian Marussi * will be exactly 3 intervals in @desc, with each entry 2241fe00b8bSCristian Marussi * representing a member of a segment in this order: 2251fe00b8bSCristian Marussi * {lowest update interval, highest update interval, step size} 2261fe00b8bSCristian Marussi * @count: Number of intervals described in @desc. 2271fe00b8bSCristian Marussi * @desc: Array of @count interval descriptor bitmask represented as detailed in 2281fe00b8bSCristian Marussi * the SCMI specification: it can be accessed using the accompanying 2291fe00b8bSCristian Marussi * macros. 2301fe00b8bSCristian Marussi * @prealloc_pool: A minimal preallocated pool of desc entries used to avoid 2311fe00b8bSCristian Marussi * lesser-than-64-bytes dynamic allocation for small @count 2321fe00b8bSCristian Marussi * values. 2331fe00b8bSCristian Marussi */ 2341fe00b8bSCristian Marussi struct scmi_sensor_intervals_info { 2351fe00b8bSCristian Marussi bool segmented; 2361fe00b8bSCristian Marussi unsigned int count; 2371fe00b8bSCristian Marussi #define SCMI_SENS_INTVL_SEGMENT_LOW 0 2381fe00b8bSCristian Marussi #define SCMI_SENS_INTVL_SEGMENT_HIGH 1 2391fe00b8bSCristian Marussi #define SCMI_SENS_INTVL_SEGMENT_STEP 2 2401fe00b8bSCristian Marussi unsigned int *desc; 2411fe00b8bSCristian Marussi #define SCMI_SENS_INTVL_GET_SECS(x) FIELD_GET(GENMASK(20, 5), (x)) 2421fe00b8bSCristian Marussi #define SCMI_SENS_INTVL_GET_EXP(x) \ 2431fe00b8bSCristian Marussi ({ \ 2441fe00b8bSCristian Marussi int __signed_exp = FIELD_GET(GENMASK(4, 0), (x)); \ 2451fe00b8bSCristian Marussi \ 2461fe00b8bSCristian Marussi if (__signed_exp & BIT(4)) \ 2471fe00b8bSCristian Marussi __signed_exp |= GENMASK(31, 5); \ 2481fe00b8bSCristian Marussi __signed_exp; \ 2491fe00b8bSCristian Marussi }) 2501fe00b8bSCristian Marussi #define SCMI_MAX_PREALLOC_POOL 16 2511fe00b8bSCristian Marussi unsigned int prealloc_pool[SCMI_MAX_PREALLOC_POOL]; 2521fe00b8bSCristian Marussi }; 2531fe00b8bSCristian Marussi 2541fe00b8bSCristian Marussi /** 2551fe00b8bSCristian Marussi * struct scmi_sensor_info - represents information related to one of the 2561fe00b8bSCristian Marussi * available sensors. 2571fe00b8bSCristian Marussi * @id: Sensor ID. 2581fe00b8bSCristian Marussi * @type: Sensor type. Chosen amongst one of @enum scmi_sensor_class. 2591fe00b8bSCristian Marussi * @scale: Power-of-10 multiplier applied to the sensor unit. 2601fe00b8bSCristian Marussi * @num_trip_points: Number of maximum configurable trip points. 2611fe00b8bSCristian Marussi * @async: Flag for asynchronous read support. 2621fe00b8bSCristian Marussi * @update: Flag for continuouos update notification support. 2631fe00b8bSCristian Marussi * @timestamped: Flag for timestamped read support. 2641fe00b8bSCristian Marussi * @tstamp_scale: Power-of-10 multiplier applied to the sensor timestamps to 2651fe00b8bSCristian Marussi * represent it in seconds. 2661fe00b8bSCristian Marussi * @num_axis: Number of supported axis if any. Reported as 0 for scalar sensors. 2671fe00b8bSCristian Marussi * @axis: Pointer to an array of @num_axis descriptors. 2681fe00b8bSCristian Marussi * @intervals: Descriptor of available update intervals. 2691fe00b8bSCristian Marussi * @sensor_config: A bitmask reporting the current sensor configuration as 2701fe00b8bSCristian Marussi * detailed in the SCMI specification: it can accessed and 2711fe00b8bSCristian Marussi * modified through the accompanying macros. 2721fe00b8bSCristian Marussi * @name: NULL-terminated string representing sensor name as advertised by 2731fe00b8bSCristian Marussi * SCMI platform. 2741fe00b8bSCristian Marussi * @extended_scalar_attrs: Flag to indicate the presence of additional extended 2751fe00b8bSCristian Marussi * attributes for this sensor. 2761fe00b8bSCristian Marussi * @sensor_power: Extended attribute representing the average power 2771fe00b8bSCristian Marussi * consumed by the sensor in microwatts (uW) when it is active. 2781fe00b8bSCristian Marussi * Reported here only for scalar sensors. 2791fe00b8bSCristian Marussi * Set to 0 if not reported by this sensor. 2801fe00b8bSCristian Marussi * @resolution: Extended attribute representing the resolution of the sensor. 2811fe00b8bSCristian Marussi * Reported here only for scalar sensors. 2821fe00b8bSCristian Marussi * Set to 0 if not reported by this sensor. 2831fe00b8bSCristian Marussi * @exponent: Extended attribute representing the power-of-10 multiplier that is 2841fe00b8bSCristian Marussi * applied to the resolution field. 2851fe00b8bSCristian Marussi * Reported here only for scalar sensors. 2861fe00b8bSCristian Marussi * Set to 0 if not reported by this sensor. 2871fe00b8bSCristian Marussi * @scalar_attrs: Extended attributes representing minimum and maximum 2881fe00b8bSCristian Marussi * measurable values by this sensor. 2891fe00b8bSCristian Marussi * Reported here only for scalar sensors. 2901fe00b8bSCristian Marussi * Set to 0 if not reported by this sensor. 2911fe00b8bSCristian Marussi */ 2921fe00b8bSCristian Marussi struct scmi_sensor_info { 2931fe00b8bSCristian Marussi unsigned int id; 2941fe00b8bSCristian Marussi unsigned int type; 2951fe00b8bSCristian Marussi int scale; 2961fe00b8bSCristian Marussi unsigned int num_trip_points; 2971fe00b8bSCristian Marussi bool async; 2981fe00b8bSCristian Marussi bool update; 2991fe00b8bSCristian Marussi bool timestamped; 3001fe00b8bSCristian Marussi int tstamp_scale; 3011fe00b8bSCristian Marussi unsigned int num_axis; 3021fe00b8bSCristian Marussi struct scmi_sensor_axis_info *axis; 3031fe00b8bSCristian Marussi struct scmi_sensor_intervals_info intervals; 3047b83c5f4SCristian Marussi unsigned int sensor_config; 3057b83c5f4SCristian Marussi #define SCMI_SENS_CFG_UPDATE_SECS_MASK GENMASK(31, 16) 3067b83c5f4SCristian Marussi #define SCMI_SENS_CFG_GET_UPDATE_SECS(x) \ 3077b83c5f4SCristian Marussi FIELD_GET(SCMI_SENS_CFG_UPDATE_SECS_MASK, (x)) 3087b83c5f4SCristian Marussi 3097b83c5f4SCristian Marussi #define SCMI_SENS_CFG_UPDATE_EXP_MASK GENMASK(15, 11) 3107b83c5f4SCristian Marussi #define SCMI_SENS_CFG_GET_UPDATE_EXP(x) \ 3117b83c5f4SCristian Marussi ({ \ 3127b83c5f4SCristian Marussi int __signed_exp = \ 3137b83c5f4SCristian Marussi FIELD_GET(SCMI_SENS_CFG_UPDATE_EXP_MASK, (x)); \ 3147b83c5f4SCristian Marussi \ 3157b83c5f4SCristian Marussi if (__signed_exp & BIT(4)) \ 3167b83c5f4SCristian Marussi __signed_exp |= GENMASK(31, 5); \ 3177b83c5f4SCristian Marussi __signed_exp; \ 3187b83c5f4SCristian Marussi }) 3197b83c5f4SCristian Marussi 3207b83c5f4SCristian Marussi #define SCMI_SENS_CFG_ROUND_MASK GENMASK(10, 9) 3217b83c5f4SCristian Marussi #define SCMI_SENS_CFG_ROUND_AUTO 2 3227b83c5f4SCristian Marussi #define SCMI_SENS_CFG_ROUND_UP 1 3237b83c5f4SCristian Marussi #define SCMI_SENS_CFG_ROUND_DOWN 0 3247b83c5f4SCristian Marussi 3257b83c5f4SCristian Marussi #define SCMI_SENS_CFG_TSTAMP_ENABLED_MASK BIT(1) 3267b83c5f4SCristian Marussi #define SCMI_SENS_CFG_TSTAMP_ENABLE 1 3277b83c5f4SCristian Marussi #define SCMI_SENS_CFG_TSTAMP_DISABLE 0 3287b83c5f4SCristian Marussi #define SCMI_SENS_CFG_IS_TSTAMP_ENABLED(x) \ 3297b83c5f4SCristian Marussi FIELD_GET(SCMI_SENS_CFG_TSTAMP_ENABLED_MASK, (x)) 3307b83c5f4SCristian Marussi 3317b83c5f4SCristian Marussi #define SCMI_SENS_CFG_SENSOR_ENABLED_MASK BIT(0) 3327b83c5f4SCristian Marussi #define SCMI_SENS_CFG_SENSOR_ENABLE 1 3337b83c5f4SCristian Marussi #define SCMI_SENS_CFG_SENSOR_DISABLE 0 3341fe00b8bSCristian Marussi char name[SCMI_MAX_STR_SIZE]; 3357b83c5f4SCristian Marussi #define SCMI_SENS_CFG_IS_ENABLED(x) FIELD_GET(BIT(0), (x)) 3361fe00b8bSCristian Marussi bool extended_scalar_attrs; 3371fe00b8bSCristian Marussi unsigned int sensor_power; 3381fe00b8bSCristian Marussi unsigned int resolution; 3391fe00b8bSCristian Marussi int exponent; 3401fe00b8bSCristian Marussi struct scmi_range_attrs scalar_attrs; 3415179c523SSudeep Holla }; 3425179c523SSudeep Holla 3435179c523SSudeep Holla /* 3445179c523SSudeep Holla * Partial list from Distributed Management Task Force (DMTF) specification: 3455179c523SSudeep Holla * DSP0249 (Platform Level Data Model specification) 3465179c523SSudeep Holla */ 3475179c523SSudeep Holla enum scmi_sensor_class { 3485179c523SSudeep Holla NONE = 0x0, 349607a4672SSudeep Holla UNSPEC = 0x1, 3505179c523SSudeep Holla TEMPERATURE_C = 0x2, 351607a4672SSudeep Holla TEMPERATURE_F = 0x3, 352607a4672SSudeep Holla TEMPERATURE_K = 0x4, 3535179c523SSudeep Holla VOLTAGE = 0x5, 3545179c523SSudeep Holla CURRENT = 0x6, 3555179c523SSudeep Holla POWER = 0x7, 3565179c523SSudeep Holla ENERGY = 0x8, 357607a4672SSudeep Holla CHARGE = 0x9, 358607a4672SSudeep Holla VOLTAMPERE = 0xA, 359607a4672SSudeep Holla NITS = 0xB, 360607a4672SSudeep Holla LUMENS = 0xC, 361607a4672SSudeep Holla LUX = 0xD, 362607a4672SSudeep Holla CANDELAS = 0xE, 363607a4672SSudeep Holla KPA = 0xF, 364607a4672SSudeep Holla PSI = 0x10, 365607a4672SSudeep Holla NEWTON = 0x11, 366607a4672SSudeep Holla CFM = 0x12, 367607a4672SSudeep Holla RPM = 0x13, 368607a4672SSudeep Holla HERTZ = 0x14, 369607a4672SSudeep Holla SECS = 0x15, 370607a4672SSudeep Holla MINS = 0x16, 371607a4672SSudeep Holla HOURS = 0x17, 372607a4672SSudeep Holla DAYS = 0x18, 373607a4672SSudeep Holla WEEKS = 0x19, 374607a4672SSudeep Holla MILS = 0x1A, 375607a4672SSudeep Holla INCHES = 0x1B, 376607a4672SSudeep Holla FEET = 0x1C, 377607a4672SSudeep Holla CUBIC_INCHES = 0x1D, 378607a4672SSudeep Holla CUBIC_FEET = 0x1E, 379607a4672SSudeep Holla METERS = 0x1F, 380607a4672SSudeep Holla CUBIC_CM = 0x20, 381607a4672SSudeep Holla CUBIC_METERS = 0x21, 382607a4672SSudeep Holla LITERS = 0x22, 383607a4672SSudeep Holla FLUID_OUNCES = 0x23, 384607a4672SSudeep Holla RADIANS = 0x24, 385607a4672SSudeep Holla STERADIANS = 0x25, 386607a4672SSudeep Holla REVOLUTIONS = 0x26, 387607a4672SSudeep Holla CYCLES = 0x27, 388607a4672SSudeep Holla GRAVITIES = 0x28, 389607a4672SSudeep Holla OUNCES = 0x29, 390607a4672SSudeep Holla POUNDS = 0x2A, 391607a4672SSudeep Holla FOOT_POUNDS = 0x2B, 392607a4672SSudeep Holla OUNCE_INCHES = 0x2C, 393607a4672SSudeep Holla GAUSS = 0x2D, 394607a4672SSudeep Holla GILBERTS = 0x2E, 395607a4672SSudeep Holla HENRIES = 0x2F, 396607a4672SSudeep Holla FARADS = 0x30, 397607a4672SSudeep Holla OHMS = 0x31, 398607a4672SSudeep Holla SIEMENS = 0x32, 399607a4672SSudeep Holla MOLES = 0x33, 400607a4672SSudeep Holla BECQUERELS = 0x34, 401607a4672SSudeep Holla PPM = 0x35, 402607a4672SSudeep Holla DECIBELS = 0x36, 403607a4672SSudeep Holla DBA = 0x37, 404607a4672SSudeep Holla DBC = 0x38, 405607a4672SSudeep Holla GRAYS = 0x39, 406607a4672SSudeep Holla SIEVERTS = 0x3A, 407607a4672SSudeep Holla COLOR_TEMP_K = 0x3B, 408607a4672SSudeep Holla BITS = 0x3C, 409607a4672SSudeep Holla BYTES = 0x3D, 410607a4672SSudeep Holla WORDS = 0x3E, 411607a4672SSudeep Holla DWORDS = 0x3F, 412607a4672SSudeep Holla QWORDS = 0x40, 413607a4672SSudeep Holla PERCENTAGE = 0x41, 414607a4672SSudeep Holla PASCALS = 0x42, 415607a4672SSudeep Holla COUNTS = 0x43, 416607a4672SSudeep Holla GRAMS = 0x44, 417607a4672SSudeep Holla NEWTON_METERS = 0x45, 418607a4672SSudeep Holla HITS = 0x46, 419607a4672SSudeep Holla MISSES = 0x47, 420607a4672SSudeep Holla RETRIES = 0x48, 421607a4672SSudeep Holla OVERRUNS = 0x49, 422607a4672SSudeep Holla UNDERRUNS = 0x4A, 423607a4672SSudeep Holla COLLISIONS = 0x4B, 424607a4672SSudeep Holla PACKETS = 0x4C, 425607a4672SSudeep Holla MESSAGES = 0x4D, 426607a4672SSudeep Holla CHARS = 0x4E, 427607a4672SSudeep Holla ERRORS = 0x4F, 428607a4672SSudeep Holla CORRECTED_ERRS = 0x50, 429607a4672SSudeep Holla UNCORRECTABLE_ERRS = 0x51, 430607a4672SSudeep Holla SQ_MILS = 0x52, 431607a4672SSudeep Holla SQ_INCHES = 0x53, 432607a4672SSudeep Holla SQ_FEET = 0x54, 433607a4672SSudeep Holla SQ_CM = 0x55, 434607a4672SSudeep Holla SQ_METERS = 0x56, 4351fe00b8bSCristian Marussi RADIANS_SEC = 0x57, 4361fe00b8bSCristian Marussi BPM = 0x58, 4371fe00b8bSCristian Marussi METERS_SEC_SQUARED = 0x59, 4381fe00b8bSCristian Marussi METERS_SEC = 0x5A, 4391fe00b8bSCristian Marussi CUBIC_METERS_SEC = 0x5B, 4401fe00b8bSCristian Marussi MM_MERCURY = 0x5C, 4411fe00b8bSCristian Marussi RADIANS_SEC_SQUARED = 0x5D, 4421fe00b8bSCristian Marussi OEM_UNIT = 0xFF 4435179c523SSudeep Holla }; 4445179c523SSudeep Holla 4455179c523SSudeep Holla /** 4469694a7f6SCristian Marussi * struct scmi_sensor_proto_ops - represents the various operations provided 4475179c523SSudeep Holla * by SCMI Sensor Protocol 4485179c523SSudeep Holla * 4495179c523SSudeep Holla * @count_get: get the count of sensors provided by SCMI 4505179c523SSudeep Holla * @info_get: get the information of the specified sensor 4519eefa43aSSudeep Holla * @trip_point_config: selects and configures a trip-point of interest 4525179c523SSudeep Holla * @reading_get: gets the current value of the sensor 453e2083d36SCristian Marussi * @reading_get_timestamped: gets the current value and timestamp, when 454e2083d36SCristian Marussi * available, of the sensor. (as of v3.0 spec) 455e2083d36SCristian Marussi * Supports multi-axis sensors for sensors which 456e2083d36SCristian Marussi * supports it and if the @reading array size of 457e2083d36SCristian Marussi * @count entry equals the sensor num_axis 4587b83c5f4SCristian Marussi * @config_get: Get sensor current configuration 4597b83c5f4SCristian Marussi * @config_set: Set sensor current configuration 4605179c523SSudeep Holla */ 4619694a7f6SCristian Marussi struct scmi_sensor_proto_ops { 4629694a7f6SCristian Marussi int (*count_get)(const struct scmi_protocol_handle *ph); 4639694a7f6SCristian Marussi const struct scmi_sensor_info *(*info_get) 4649694a7f6SCristian Marussi (const struct scmi_protocol_handle *ph, u32 sensor_id); 4659694a7f6SCristian Marussi int (*trip_point_config)(const struct scmi_protocol_handle *ph, 4669694a7f6SCristian Marussi u32 sensor_id, u8 trip_id, u64 trip_value); 4679694a7f6SCristian Marussi int (*reading_get)(const struct scmi_protocol_handle *ph, u32 sensor_id, 4689694a7f6SCristian Marussi u64 *value); 4699694a7f6SCristian Marussi int (*reading_get_timestamped)(const struct scmi_protocol_handle *ph, 4709694a7f6SCristian Marussi u32 sensor_id, u8 count, 4719694a7f6SCristian Marussi struct scmi_sensor_reading *readings); 4729694a7f6SCristian Marussi int (*config_get)(const struct scmi_protocol_handle *ph, 4739694a7f6SCristian Marussi u32 sensor_id, u32 *sensor_config); 4749694a7f6SCristian Marussi int (*config_set)(const struct scmi_protocol_handle *ph, 4759694a7f6SCristian Marussi u32 sensor_id, u32 sensor_config); 4769694a7f6SCristian Marussi }; 4779694a7f6SCristian Marussi 47876a65509SSudeep Holla /** 4797e029344SCristian Marussi * struct scmi_reset_proto_ops - represents the various operations provided 48095a15d80SSudeep Holla * by SCMI Reset Protocol 48195a15d80SSudeep Holla * 48295a15d80SSudeep Holla * @num_domains_get: get the count of reset domains provided by SCMI 48395a15d80SSudeep Holla * @name_get: gets the name of a reset domain 48495a15d80SSudeep Holla * @latency_get: gets the reset latency for the specified reset domain 48595a15d80SSudeep Holla * @reset: resets the specified reset domain 48695a15d80SSudeep Holla * @assert: explicitly assert reset signal of the specified reset domain 48795a15d80SSudeep Holla * @deassert: explicitly deassert reset signal of the specified reset domain 48895a15d80SSudeep Holla */ 4897e029344SCristian Marussi struct scmi_reset_proto_ops { 4907e029344SCristian Marussi int (*num_domains_get)(const struct scmi_protocol_handle *ph); 491992be5d3SCristian Marussi const char *(*name_get)(const struct scmi_protocol_handle *ph, 492992be5d3SCristian Marussi u32 domain); 4937e029344SCristian Marussi int (*latency_get)(const struct scmi_protocol_handle *ph, u32 domain); 4947e029344SCristian Marussi int (*reset)(const struct scmi_protocol_handle *ph, u32 domain); 4957e029344SCristian Marussi int (*assert)(const struct scmi_protocol_handle *ph, u32 domain); 4967e029344SCristian Marussi int (*deassert)(const struct scmi_protocol_handle *ph, u32 domain); 4977e029344SCristian Marussi }; 4987e029344SCristian Marussi 4994c74701bSCristian Marussi enum scmi_voltage_level_mode { 5004c74701bSCristian Marussi SCMI_VOLTAGE_LEVEL_SET_AUTO, 5014c74701bSCristian Marussi SCMI_VOLTAGE_LEVEL_SET_SYNC, 5024c74701bSCristian Marussi }; 5034c74701bSCristian Marussi 50495a15d80SSudeep Holla /** 5052add5cacSCristian Marussi * struct scmi_voltage_info - describe one available SCMI Voltage Domain 5062add5cacSCristian Marussi * 5072add5cacSCristian Marussi * @id: the domain ID as advertised by the platform 5082add5cacSCristian Marussi * @segmented: defines the layout of the entries of array @levels_uv. 5092add5cacSCristian Marussi * - when True the entries are to be interpreted as triplets, 5102add5cacSCristian Marussi * each defining a segment representing a range of equally 5112add5cacSCristian Marussi * space voltages: <lowest_volts>, <highest_volt>, <step_uV> 5122add5cacSCristian Marussi * - when False the entries simply represent a single discrete 5132add5cacSCristian Marussi * supported voltage level 5142add5cacSCristian Marussi * @negative_volts_allowed: True if any of the entries of @levels_uv represent 5152add5cacSCristian Marussi * a negative voltage. 5164c74701bSCristian Marussi * @async_level_set: True when the voltage domain supports asynchronous level 5174c74701bSCristian Marussi * set commands. 5182add5cacSCristian Marussi * @name: name assigned to the Voltage Domain by platform 5192add5cacSCristian Marussi * @num_levels: number of total entries in @levels_uv. 5202add5cacSCristian Marussi * @levels_uv: array of entries describing the available voltage levels for 5212add5cacSCristian Marussi * this domain. 5222add5cacSCristian Marussi */ 5232add5cacSCristian Marussi struct scmi_voltage_info { 5242add5cacSCristian Marussi unsigned int id; 5252add5cacSCristian Marussi bool segmented; 5262add5cacSCristian Marussi bool negative_volts_allowed; 5274c74701bSCristian Marussi bool async_level_set; 5282add5cacSCristian Marussi char name[SCMI_MAX_STR_SIZE]; 5292add5cacSCristian Marussi unsigned int num_levels; 5302add5cacSCristian Marussi #define SCMI_VOLTAGE_SEGMENT_LOW 0 5312add5cacSCristian Marussi #define SCMI_VOLTAGE_SEGMENT_HIGH 1 5322add5cacSCristian Marussi #define SCMI_VOLTAGE_SEGMENT_STEP 2 5332add5cacSCristian Marussi int *levels_uv; 5342add5cacSCristian Marussi }; 5352add5cacSCristian Marussi 5362add5cacSCristian Marussi /** 537fe4894d9SCristian Marussi * struct scmi_voltage_proto_ops - represents the various operations provided 5382add5cacSCristian Marussi * by SCMI Voltage Protocol 5392add5cacSCristian Marussi * 5402add5cacSCristian Marussi * @num_domains_get: get the count of voltage domains provided by SCMI 5412add5cacSCristian Marussi * @info_get: get the information of the specified domain 5422add5cacSCristian Marussi * @config_set: set the config for the specified domain 5432add5cacSCristian Marussi * @config_get: get the config of the specified domain 5442add5cacSCristian Marussi * @level_set: set the voltage level for the specified domain 5452add5cacSCristian Marussi * @level_get: get the voltage level of the specified domain 5462add5cacSCristian Marussi */ 547fe4894d9SCristian Marussi struct scmi_voltage_proto_ops { 548fe4894d9SCristian Marussi int (*num_domains_get)(const struct scmi_protocol_handle *ph); 549fe4894d9SCristian Marussi const struct scmi_voltage_info __must_check *(*info_get) 550fe4894d9SCristian Marussi (const struct scmi_protocol_handle *ph, u32 domain_id); 551fe4894d9SCristian Marussi int (*config_set)(const struct scmi_protocol_handle *ph, u32 domain_id, 552fe4894d9SCristian Marussi u32 config); 553fe4894d9SCristian Marussi #define SCMI_VOLTAGE_ARCH_STATE_OFF 0x0 554fe4894d9SCristian Marussi #define SCMI_VOLTAGE_ARCH_STATE_ON 0x7 555fe4894d9SCristian Marussi int (*config_get)(const struct scmi_protocol_handle *ph, u32 domain_id, 556fe4894d9SCristian Marussi u32 *config); 557fe4894d9SCristian Marussi int (*level_set)(const struct scmi_protocol_handle *ph, u32 domain_id, 5584c74701bSCristian Marussi enum scmi_voltage_level_mode mode, s32 volt_uV); 559fe4894d9SCristian Marussi int (*level_get)(const struct scmi_protocol_handle *ph, u32 domain_id, 560fe4894d9SCristian Marussi s32 *volt_uV); 561fe4894d9SCristian Marussi }; 562fe4894d9SCristian Marussi 5632add5cacSCristian Marussi /** 5640316f99cSCristian Marussi * struct scmi_powercap_info - Describe one available Powercap domain 5650316f99cSCristian Marussi * 5660316f99cSCristian Marussi * @id: Domain ID as advertised by the platform. 5670316f99cSCristian Marussi * @notify_powercap_cap_change: CAP change notification support. 5680316f99cSCristian Marussi * @notify_powercap_measurement_change: MEASUREMENTS change notifications 5690316f99cSCristian Marussi * support. 5700316f99cSCristian Marussi * @async_powercap_cap_set: Asynchronous CAP set support. 5710316f99cSCristian Marussi * @powercap_cap_config: CAP configuration support. 5720316f99cSCristian Marussi * @powercap_monitoring: Monitoring (measurements) support. 5730316f99cSCristian Marussi * @powercap_pai_config: PAI configuration support. 5740316f99cSCristian Marussi * @powercap_scale_mw: Domain reports power data in milliwatt units. 5750316f99cSCristian Marussi * @powercap_scale_uw: Domain reports power data in microwatt units. 5760316f99cSCristian Marussi * Note that, when both @powercap_scale_mw and 5770316f99cSCristian Marussi * @powercap_scale_uw are set to false, the domain 5780316f99cSCristian Marussi * reports power data on an abstract linear scale. 5790316f99cSCristian Marussi * @name: name assigned to the Powercap Domain by platform. 5800316f99cSCristian Marussi * @min_pai: Minimum configurable PAI. 5810316f99cSCristian Marussi * @max_pai: Maximum configurable PAI. 5820316f99cSCristian Marussi * @pai_step: Step size between two consecutive PAI values. 5830316f99cSCristian Marussi * @min_power_cap: Minimum configurable CAP. 5840316f99cSCristian Marussi * @max_power_cap: Maximum configurable CAP. 5850316f99cSCristian Marussi * @power_cap_step: Step size between two consecutive CAP values. 5860316f99cSCristian Marussi * @sustainable_power: Maximum sustainable power consumption for this domain 5870316f99cSCristian Marussi * under normal conditions. 5880316f99cSCristian Marussi * @accuracy: The accuracy with which the power is measured and reported in 5890316f99cSCristian Marussi * integral multiples of 0.001 percent. 5900316f99cSCristian Marussi * @parent_id: Identifier of the containing parent power capping domain, or the 5910316f99cSCristian Marussi * value 0xFFFFFFFF if this powercap domain is a root domain not 5920316f99cSCristian Marussi * contained in any other domain. 5930316f99cSCristian Marussi */ 5940316f99cSCristian Marussi struct scmi_powercap_info { 5950316f99cSCristian Marussi unsigned int id; 5960316f99cSCristian Marussi bool notify_powercap_cap_change; 5970316f99cSCristian Marussi bool notify_powercap_measurement_change; 5980316f99cSCristian Marussi bool async_powercap_cap_set; 5990316f99cSCristian Marussi bool powercap_cap_config; 6000316f99cSCristian Marussi bool powercap_monitoring; 6010316f99cSCristian Marussi bool powercap_pai_config; 6020316f99cSCristian Marussi bool powercap_scale_mw; 6030316f99cSCristian Marussi bool powercap_scale_uw; 604*855aa26eSCristian Marussi bool fastchannels; 6050316f99cSCristian Marussi char name[SCMI_MAX_STR_SIZE]; 6060316f99cSCristian Marussi unsigned int min_pai; 6070316f99cSCristian Marussi unsigned int max_pai; 6080316f99cSCristian Marussi unsigned int pai_step; 6090316f99cSCristian Marussi unsigned int min_power_cap; 6100316f99cSCristian Marussi unsigned int max_power_cap; 6110316f99cSCristian Marussi unsigned int power_cap_step; 6120316f99cSCristian Marussi unsigned int sustainable_power; 6130316f99cSCristian Marussi unsigned int accuracy; 6140316f99cSCristian Marussi #define SCMI_POWERCAP_ROOT_ZONE_ID 0xFFFFFFFFUL 6150316f99cSCristian Marussi unsigned int parent_id; 616*855aa26eSCristian Marussi struct scmi_fc_info *fc_info; 6170316f99cSCristian Marussi }; 6180316f99cSCristian Marussi 6190316f99cSCristian Marussi /** 6200316f99cSCristian Marussi * struct scmi_powercap_proto_ops - represents the various operations provided 6210316f99cSCristian Marussi * by SCMI Powercap Protocol 6220316f99cSCristian Marussi * 6230316f99cSCristian Marussi * @num_domains_get: get the count of powercap domains provided by SCMI. 6240316f99cSCristian Marussi * @info_get: get the information for the specified domain. 6250316f99cSCristian Marussi * @cap_get: get the current CAP value for the specified domain. 6260316f99cSCristian Marussi * @cap_set: set the CAP value for the specified domain to the provided value; 6270316f99cSCristian Marussi * if the domain supports setting the CAP with an asynchronous command 6280316f99cSCristian Marussi * this request will finally trigger an asynchronous transfer, but, if 6290316f99cSCristian Marussi * @ignore_dresp here is set to true, this call will anyway return 6300316f99cSCristian Marussi * immediately without waiting for the related delayed response. 6310316f99cSCristian Marussi * @pai_get: get the current PAI value for the specified domain. 6320316f99cSCristian Marussi * @pai_set: set the PAI value for the specified domain to the provided value. 6330316f99cSCristian Marussi * @measurements_get: retrieve the current average power measurements for the 6340316f99cSCristian Marussi * specified domain and the related PAI upon which is 6350316f99cSCristian Marussi * calculated. 6360316f99cSCristian Marussi * @measurements_threshold_set: set the desired low and high power thresholds 6370316f99cSCristian Marussi * to be used when registering for notification 6380316f99cSCristian Marussi * of type POWERCAP_MEASUREMENTS_NOTIFY with this 6390316f99cSCristian Marussi * powercap domain. 6400316f99cSCristian Marussi * Note that this must be called at least once 6410316f99cSCristian Marussi * before registering any callback with the usual 6420316f99cSCristian Marussi * @scmi_notify_ops; moreover, in case this method 6430316f99cSCristian Marussi * is called with measurement notifications already 6440316f99cSCristian Marussi * enabled it will also trigger, transparently, a 6450316f99cSCristian Marussi * proper update of the power thresholds configured 6460316f99cSCristian Marussi * in the SCMI backend server. 6470316f99cSCristian Marussi * @measurements_threshold_get: get the currently configured low and high power 6480316f99cSCristian Marussi * thresholds used when registering callbacks for 6490316f99cSCristian Marussi * notification POWERCAP_MEASUREMENTS_NOTIFY. 6500316f99cSCristian Marussi */ 6510316f99cSCristian Marussi struct scmi_powercap_proto_ops { 6520316f99cSCristian Marussi int (*num_domains_get)(const struct scmi_protocol_handle *ph); 6530316f99cSCristian Marussi const struct scmi_powercap_info __must_check *(*info_get) 6540316f99cSCristian Marussi (const struct scmi_protocol_handle *ph, u32 domain_id); 6550316f99cSCristian Marussi int (*cap_get)(const struct scmi_protocol_handle *ph, u32 domain_id, 6560316f99cSCristian Marussi u32 *power_cap); 6570316f99cSCristian Marussi int (*cap_set)(const struct scmi_protocol_handle *ph, u32 domain_id, 6580316f99cSCristian Marussi u32 power_cap, bool ignore_dresp); 6590316f99cSCristian Marussi int (*pai_get)(const struct scmi_protocol_handle *ph, u32 domain_id, 6600316f99cSCristian Marussi u32 *pai); 6610316f99cSCristian Marussi int (*pai_set)(const struct scmi_protocol_handle *ph, u32 domain_id, 6620316f99cSCristian Marussi u32 pai); 6630316f99cSCristian Marussi int (*measurements_get)(const struct scmi_protocol_handle *ph, 6640316f99cSCristian Marussi u32 domain_id, u32 *average_power, u32 *pai); 6650316f99cSCristian Marussi int (*measurements_threshold_set)(const struct scmi_protocol_handle *ph, 6660316f99cSCristian Marussi u32 domain_id, u32 power_thresh_low, 6670316f99cSCristian Marussi u32 power_thresh_high); 6680316f99cSCristian Marussi int (*measurements_threshold_get)(const struct scmi_protocol_handle *ph, 6690316f99cSCristian Marussi u32 domain_id, u32 *power_thresh_low, 6700316f99cSCristian Marussi u32 *power_thresh_high); 6710316f99cSCristian Marussi }; 6720316f99cSCristian Marussi 6730316f99cSCristian Marussi /** 674e7c215f3SCristian Marussi * struct scmi_notify_ops - represents notifications' operations provided by 675e7c215f3SCristian Marussi * SCMI core 6765ad3d1cfSCristian Marussi * @devm_event_notifier_register: Managed registration of a notifier_block for 6775ad3d1cfSCristian Marussi * the requested event 6785ad3d1cfSCristian Marussi * @devm_event_notifier_unregister: Managed unregistration of a notifier_block 6795ad3d1cfSCristian Marussi * for the requested event 680aa1fd3e4SCristian Marussi * @event_notifier_register: Register a notifier_block for the requested event 681aa1fd3e4SCristian Marussi * @event_notifier_unregister: Unregister a notifier_block for the requested 682e7c215f3SCristian Marussi * event 683e7c215f3SCristian Marussi * 684e7c215f3SCristian Marussi * A user can register/unregister its own notifier_block against the wanted 685e7c215f3SCristian Marussi * platform instance regarding the desired event identified by the 686e7c215f3SCristian Marussi * tuple: (proto_id, evt_id, src_id) using the provided register/unregister 687e7c215f3SCristian Marussi * interface where: 688e7c215f3SCristian Marussi * 6895ad3d1cfSCristian Marussi * @sdev: The scmi_device to use when calling the devres managed ops devm_ 6905ad3d1cfSCristian Marussi * @handle: The handle identifying the platform instance to use, when not 6915ad3d1cfSCristian Marussi * calling the managed ops devm_ 692e7c215f3SCristian Marussi * @proto_id: The protocol ID as in SCMI Specification 693e7c215f3SCristian Marussi * @evt_id: The message ID of the desired event as in SCMI Specification 694e7c215f3SCristian Marussi * @src_id: A pointer to the desired source ID if different sources are 695e7c215f3SCristian Marussi * possible for the protocol (like domain_id, sensor_id...etc) 696e7c215f3SCristian Marussi * 697e7c215f3SCristian Marussi * @src_id can be provided as NULL if it simply does NOT make sense for 698e7c215f3SCristian Marussi * the protocol at hand, OR if the user is explicitly interested in 699e7c215f3SCristian Marussi * receiving notifications from ANY existent source associated to the 700e7c215f3SCristian Marussi * specified proto_id / evt_id. 701e7c215f3SCristian Marussi * 702e7c215f3SCristian Marussi * Received notifications are finally delivered to the registered users, 703e7c215f3SCristian Marussi * invoking the callback provided with the notifier_block *nb as follows: 704e7c215f3SCristian Marussi * 705e7c215f3SCristian Marussi * int user_cb(nb, evt_id, report) 706e7c215f3SCristian Marussi * 707e7c215f3SCristian Marussi * with: 708e7c215f3SCristian Marussi * 709e7c215f3SCristian Marussi * @nb: The notifier block provided by the user 710e7c215f3SCristian Marussi * @evt_id: The message ID of the delivered event 711e7c215f3SCristian Marussi * @report: A custom struct describing the specific event delivered 712e7c215f3SCristian Marussi */ 713e7c215f3SCristian Marussi struct scmi_notify_ops { 7145ad3d1cfSCristian Marussi int (*devm_event_notifier_register)(struct scmi_device *sdev, 7155ad3d1cfSCristian Marussi u8 proto_id, u8 evt_id, 7165ad3d1cfSCristian Marussi const u32 *src_id, 7175ad3d1cfSCristian Marussi struct notifier_block *nb); 7185ad3d1cfSCristian Marussi int (*devm_event_notifier_unregister)(struct scmi_device *sdev, 7195ad3d1cfSCristian Marussi u8 proto_id, u8 evt_id, 7205ad3d1cfSCristian Marussi const u32 *src_id, 7215ad3d1cfSCristian Marussi struct notifier_block *nb); 722aa1fd3e4SCristian Marussi int (*event_notifier_register)(const struct scmi_handle *handle, 7235ad3d1cfSCristian Marussi u8 proto_id, u8 evt_id, 7245ad3d1cfSCristian Marussi const u32 *src_id, 725e7c215f3SCristian Marussi struct notifier_block *nb); 726aa1fd3e4SCristian Marussi int (*event_notifier_unregister)(const struct scmi_handle *handle, 7275ad3d1cfSCristian Marussi u8 proto_id, u8 evt_id, 7285ad3d1cfSCristian Marussi const u32 *src_id, 729e7c215f3SCristian Marussi struct notifier_block *nb); 730e7c215f3SCristian Marussi }; 731e7c215f3SCristian Marussi 732e7c215f3SCristian Marussi /** 733aa4f886fSSudeep Holla * struct scmi_handle - Handle returned to ARM SCMI clients for usage. 734aa4f886fSSudeep Holla * 735aa4f886fSSudeep Holla * @dev: pointer to the SCMI device 736b6f20ff8SSudeep Holla * @version: pointer to the structure containing SCMI version information 737d9107999SCristian Marussi * @devm_protocol_acquire: devres managed method to get hold of a protocol, 738d9107999SCristian Marussi * causing its initialization and related resource 739d9107999SCristian Marussi * accounting 74023934efeSCristian Marussi * @devm_protocol_get: devres managed method to acquire a protocol and get specific 74123934efeSCristian Marussi * operations and a dedicated protocol handler 74223934efeSCristian Marussi * @devm_protocol_put: devres managed method to release a protocol 74369255e74SCristian Marussi * @is_transport_atomic: method to check if the underlying transport for this 74469255e74SCristian Marussi * instance handle is configured to support atomic 74569255e74SCristian Marussi * transactions for commands. 74669255e74SCristian Marussi * Some users of the SCMI stack in the upper layers could 74769255e74SCristian Marussi * be interested to know if they can assume SCMI 74869255e74SCristian Marussi * command transactions associated to this handle will 74969255e74SCristian Marussi * never sleep and act accordingly. 75005976c5fSCristian Marussi * An optional atomic threshold value could be returned 75105976c5fSCristian Marussi * where configured. 752e7c215f3SCristian Marussi * @notify_ops: pointer to set of notifications related operations 753aa4f886fSSudeep Holla */ 754aa4f886fSSudeep Holla struct scmi_handle { 755aa4f886fSSudeep Holla struct device *dev; 756b6f20ff8SSudeep Holla struct scmi_revision_info *version; 75723934efeSCristian Marussi 758d9107999SCristian Marussi int __must_check (*devm_protocol_acquire)(struct scmi_device *sdev, 759d9107999SCristian Marussi u8 proto); 76023934efeSCristian Marussi const void __must_check * 76123934efeSCristian Marussi (*devm_protocol_get)(struct scmi_device *sdev, u8 proto, 76223934efeSCristian Marussi struct scmi_protocol_handle **ph); 76323934efeSCristian Marussi void (*devm_protocol_put)(struct scmi_device *sdev, u8 proto); 76405976c5fSCristian Marussi bool (*is_transport_atomic)(const struct scmi_handle *handle, 76505976c5fSCristian Marussi unsigned int *atomic_threshold); 76623934efeSCristian Marussi 76782894c1dSRikard Falkeborn const struct scmi_notify_ops *notify_ops; 768b6f20ff8SSudeep Holla }; 769b6f20ff8SSudeep Holla 770b6f20ff8SSudeep Holla enum scmi_std_protocol { 771b6f20ff8SSudeep Holla SCMI_PROTOCOL_BASE = 0x10, 772b6f20ff8SSudeep Holla SCMI_PROTOCOL_POWER = 0x11, 773b6f20ff8SSudeep Holla SCMI_PROTOCOL_SYSTEM = 0x12, 774b6f20ff8SSudeep Holla SCMI_PROTOCOL_PERF = 0x13, 775b6f20ff8SSudeep Holla SCMI_PROTOCOL_CLOCK = 0x14, 776b6f20ff8SSudeep Holla SCMI_PROTOCOL_SENSOR = 0x15, 77795a15d80SSudeep Holla SCMI_PROTOCOL_RESET = 0x16, 7782add5cacSCristian Marussi SCMI_PROTOCOL_VOLTAGE = 0x17, 7790316f99cSCristian Marussi SCMI_PROTOCOL_POWERCAP = 0x18, 780aa4f886fSSudeep Holla }; 781933c5044SSudeep Holla 782a8803055SCristian Marussi enum scmi_system_events { 783a8803055SCristian Marussi SCMI_SYSTEM_SHUTDOWN, 784a8803055SCristian Marussi SCMI_SYSTEM_COLDRESET, 785a8803055SCristian Marussi SCMI_SYSTEM_WARMRESET, 786a8803055SCristian Marussi SCMI_SYSTEM_POWERUP, 787a8803055SCristian Marussi SCMI_SYSTEM_SUSPEND, 788a8803055SCristian Marussi SCMI_SYSTEM_MAX 789a8803055SCristian Marussi }; 790a8803055SCristian Marussi 791933c5044SSudeep Holla struct scmi_device { 792933c5044SSudeep Holla u32 id; 793933c5044SSudeep Holla u8 protocol_id; 794ee7a9c9fSSudeep Holla const char *name; 795933c5044SSudeep Holla struct device dev; 796933c5044SSudeep Holla struct scmi_handle *handle; 797933c5044SSudeep Holla }; 798933c5044SSudeep Holla 799933c5044SSudeep Holla #define to_scmi_dev(d) container_of(d, struct scmi_device, dev) 800933c5044SSudeep Holla 801933c5044SSudeep Holla struct scmi_device * 802ee7a9c9fSSudeep Holla scmi_device_create(struct device_node *np, struct device *parent, int protocol, 803ee7a9c9fSSudeep Holla const char *name); 804933c5044SSudeep Holla void scmi_device_destroy(struct scmi_device *scmi_dev); 805933c5044SSudeep Holla 806933c5044SSudeep Holla struct scmi_device_id { 807933c5044SSudeep Holla u8 protocol_id; 808ee7a9c9fSSudeep Holla const char *name; 809933c5044SSudeep Holla }; 810933c5044SSudeep Holla 811933c5044SSudeep Holla struct scmi_driver { 812933c5044SSudeep Holla const char *name; 813933c5044SSudeep Holla int (*probe)(struct scmi_device *sdev); 814933c5044SSudeep Holla void (*remove)(struct scmi_device *sdev); 815933c5044SSudeep Holla const struct scmi_device_id *id_table; 816933c5044SSudeep Holla 817933c5044SSudeep Holla struct device_driver driver; 818933c5044SSudeep Holla }; 819933c5044SSudeep Holla 820933c5044SSudeep Holla #define to_scmi_driver(d) container_of(d, struct scmi_driver, driver) 821933c5044SSudeep Holla 82266d90f6eSSudeep Holla #if IS_REACHABLE(CONFIG_ARM_SCMI_PROTOCOL) 823933c5044SSudeep Holla int scmi_driver_register(struct scmi_driver *driver, 824933c5044SSudeep Holla struct module *owner, const char *mod_name); 825933c5044SSudeep Holla void scmi_driver_unregister(struct scmi_driver *driver); 826933c5044SSudeep Holla #else 827933c5044SSudeep Holla static inline int 828933c5044SSudeep Holla scmi_driver_register(struct scmi_driver *driver, struct module *owner, 829933c5044SSudeep Holla const char *mod_name) 830933c5044SSudeep Holla { 831933c5044SSudeep Holla return -EINVAL; 832933c5044SSudeep Holla } 833933c5044SSudeep Holla 834933c5044SSudeep Holla static inline void scmi_driver_unregister(struct scmi_driver *driver) {} 835933c5044SSudeep Holla #endif /* CONFIG_ARM_SCMI_PROTOCOL */ 836933c5044SSudeep Holla 837933c5044SSudeep Holla #define scmi_register(driver) \ 838933c5044SSudeep Holla scmi_driver_register(driver, THIS_MODULE, KBUILD_MODNAME) 839933c5044SSudeep Holla #define scmi_unregister(driver) \ 840933c5044SSudeep Holla scmi_driver_unregister(driver) 841933c5044SSudeep Holla 842933c5044SSudeep Holla /** 843933c5044SSudeep Holla * module_scmi_driver() - Helper macro for registering a scmi driver 844933c5044SSudeep Holla * @__scmi_driver: scmi_driver structure 845933c5044SSudeep Holla * 846933c5044SSudeep Holla * Helper macro for scmi drivers to set up proper module init / exit 847933c5044SSudeep Holla * functions. Replaces module_init() and module_exit() and keeps people from 848933c5044SSudeep Holla * printing pointless things to the kernel log when their driver is loaded. 849933c5044SSudeep Holla */ 850933c5044SSudeep Holla #define module_scmi_driver(__scmi_driver) \ 851933c5044SSudeep Holla module_driver(__scmi_driver, scmi_register, scmi_unregister) 852933c5044SSudeep Holla 853f5800e0bSCristian Marussi /** 854f5800e0bSCristian Marussi * module_scmi_protocol() - Helper macro for registering a scmi protocol 855f5800e0bSCristian Marussi * @__scmi_protocol: scmi_protocol structure 856f5800e0bSCristian Marussi * 857f5800e0bSCristian Marussi * Helper macro for scmi drivers to set up proper module init / exit 858f5800e0bSCristian Marussi * functions. Replaces module_init() and module_exit() and keeps people from 859f5800e0bSCristian Marussi * printing pointless things to the kernel log when their driver is loaded. 860f5800e0bSCristian Marussi */ 861f5800e0bSCristian Marussi #define module_scmi_protocol(__scmi_protocol) \ 862f5800e0bSCristian Marussi module_driver(__scmi_protocol, \ 863f5800e0bSCristian Marussi scmi_protocol_register, scmi_protocol_unregister) 864f5800e0bSCristian Marussi 86548dc16e2SCristian Marussi struct scmi_protocol; 86648dc16e2SCristian Marussi int scmi_protocol_register(const struct scmi_protocol *proto); 86748dc16e2SCristian Marussi void scmi_protocol_unregister(const struct scmi_protocol *proto); 86870771c69SSudeep Holla 869e27077bcSCristian Marussi /* SCMI Notification API - Custom Event Reports */ 870e27077bcSCristian Marussi enum scmi_notification_events { 871e27077bcSCristian Marussi SCMI_EVENT_POWER_STATE_CHANGED = 0x0, 8727aa75496SCristian Marussi SCMI_EVENT_CLOCK_RATE_CHANGED = 0x0, 8737aa75496SCristian Marussi SCMI_EVENT_CLOCK_RATE_CHANGE_REQUESTED = 0x1, 874fb5086dcSCristian Marussi SCMI_EVENT_PERFORMANCE_LIMITS_CHANGED = 0x0, 875fb5086dcSCristian Marussi SCMI_EVENT_PERFORMANCE_LEVEL_CHANGED = 0x1, 876128e3e93SCristian Marussi SCMI_EVENT_SENSOR_TRIP_POINT_EVENT = 0x0, 877e3811190SCristian Marussi SCMI_EVENT_SENSOR_UPDATE = 0x1, 878469ca182SCristian Marussi SCMI_EVENT_RESET_ISSUED = 0x0, 879585dfab3SCristian Marussi SCMI_EVENT_BASE_ERROR_EVENT = 0x0, 880a8803055SCristian Marussi SCMI_EVENT_SYSTEM_POWER_STATE_NOTIFIER = 0x0, 8810316f99cSCristian Marussi SCMI_EVENT_POWERCAP_CAP_CHANGED = 0x0, 8820316f99cSCristian Marussi SCMI_EVENT_POWERCAP_MEASUREMENTS_CHANGED = 0x1, 883e27077bcSCristian Marussi }; 884e27077bcSCristian Marussi 885e27077bcSCristian Marussi struct scmi_power_state_changed_report { 88672a5eb9dSCristian Marussi ktime_t timestamp; 88772a5eb9dSCristian Marussi unsigned int agent_id; 88872a5eb9dSCristian Marussi unsigned int domain_id; 88972a5eb9dSCristian Marussi unsigned int power_state; 890e27077bcSCristian Marussi }; 891e27077bcSCristian Marussi 8927aa75496SCristian Marussi struct scmi_clock_rate_notif_report { 8937aa75496SCristian Marussi ktime_t timestamp; 8947aa75496SCristian Marussi unsigned int agent_id; 8957aa75496SCristian Marussi unsigned int clock_id; 8967aa75496SCristian Marussi unsigned long long rate; 8977aa75496SCristian Marussi }; 8987aa75496SCristian Marussi 899a8803055SCristian Marussi struct scmi_system_power_state_notifier_report { 900a8803055SCristian Marussi ktime_t timestamp; 901a8803055SCristian Marussi unsigned int agent_id; 9027097f298SCristian Marussi #define SCMI_SYSPOWER_IS_REQUEST_GRACEFUL(flags) ((flags) & BIT(0)) 903a8803055SCristian Marussi unsigned int flags; 904a8803055SCristian Marussi unsigned int system_state; 9057097f298SCristian Marussi unsigned int timeout; 906a8803055SCristian Marussi }; 907a8803055SCristian Marussi 908fb5086dcSCristian Marussi struct scmi_perf_limits_report { 90972a5eb9dSCristian Marussi ktime_t timestamp; 91072a5eb9dSCristian Marussi unsigned int agent_id; 91172a5eb9dSCristian Marussi unsigned int domain_id; 91272a5eb9dSCristian Marussi unsigned int range_max; 91372a5eb9dSCristian Marussi unsigned int range_min; 914fb5086dcSCristian Marussi }; 915fb5086dcSCristian Marussi 916fb5086dcSCristian Marussi struct scmi_perf_level_report { 91772a5eb9dSCristian Marussi ktime_t timestamp; 91872a5eb9dSCristian Marussi unsigned int agent_id; 91972a5eb9dSCristian Marussi unsigned int domain_id; 92072a5eb9dSCristian Marussi unsigned int performance_level; 921fb5086dcSCristian Marussi }; 922fb5086dcSCristian Marussi 923128e3e93SCristian Marussi struct scmi_sensor_trip_point_report { 92472a5eb9dSCristian Marussi ktime_t timestamp; 92572a5eb9dSCristian Marussi unsigned int agent_id; 92672a5eb9dSCristian Marussi unsigned int sensor_id; 92772a5eb9dSCristian Marussi unsigned int trip_point_desc; 928128e3e93SCristian Marussi }; 929128e3e93SCristian Marussi 930e3811190SCristian Marussi struct scmi_sensor_update_report { 931e3811190SCristian Marussi ktime_t timestamp; 932e3811190SCristian Marussi unsigned int agent_id; 933e3811190SCristian Marussi unsigned int sensor_id; 934e3811190SCristian Marussi unsigned int readings_count; 935e3811190SCristian Marussi struct scmi_sensor_reading readings[]; 936e3811190SCristian Marussi }; 937e3811190SCristian Marussi 938469ca182SCristian Marussi struct scmi_reset_issued_report { 93972a5eb9dSCristian Marussi ktime_t timestamp; 94072a5eb9dSCristian Marussi unsigned int agent_id; 94172a5eb9dSCristian Marussi unsigned int domain_id; 94272a5eb9dSCristian Marussi unsigned int reset_state; 943469ca182SCristian Marussi }; 944469ca182SCristian Marussi 945585dfab3SCristian Marussi struct scmi_base_error_report { 94672a5eb9dSCristian Marussi ktime_t timestamp; 94772a5eb9dSCristian Marussi unsigned int agent_id; 948585dfab3SCristian Marussi bool fatal; 94972a5eb9dSCristian Marussi unsigned int cmd_count; 95072a5eb9dSCristian Marussi unsigned long long reports[]; 951585dfab3SCristian Marussi }; 952585dfab3SCristian Marussi 9530316f99cSCristian Marussi struct scmi_powercap_cap_changed_report { 9540316f99cSCristian Marussi ktime_t timestamp; 9550316f99cSCristian Marussi unsigned int agent_id; 9560316f99cSCristian Marussi unsigned int domain_id; 9570316f99cSCristian Marussi unsigned int power_cap; 9580316f99cSCristian Marussi unsigned int pai; 9590316f99cSCristian Marussi }; 9600316f99cSCristian Marussi 9610316f99cSCristian Marussi struct scmi_powercap_meas_changed_report { 9620316f99cSCristian Marussi ktime_t timestamp; 9630316f99cSCristian Marussi unsigned int agent_id; 9640316f99cSCristian Marussi unsigned int domain_id; 9650316f99cSCristian Marussi unsigned int power; 9660316f99cSCristian Marussi }; 96770771c69SSudeep Holla #endif /* _LINUX_SCMI_PROTOCOL_H */ 968