blob: a8c5dd4b2d8f1e52e18577f8bf3390e95ff101fb [file] [log] [blame]
Chris Caina8857c52021-01-27 11:53:05 -06001#pragma once
2
3#include "occ_errors.hpp"
George Liuf3b75142021-06-10 11:22:50 +08004#include "utils.hpp"
Chris Caina8857c52021-01-27 11:53:05 -06005
Eddie Jamesb3c57042022-11-15 14:00:08 -06006#include <fmt/format.h>
Eddie Jamesb2515462022-11-08 17:01:04 -06007
Chris Caina8857c52021-01-27 11:53:05 -06008#include <org/open_power/OCC/PassThrough/server.hpp>
9#include <sdbusplus/bus.hpp>
10#include <sdbusplus/server/object.hpp>
George Liub5ca1012021-09-10 12:53:11 +080011
Chris Caina8857c52021-01-27 11:53:05 -060012#include <string>
13
14namespace open_power
15{
16namespace occ
17{
18
19// For waiting on signals
20namespace sdbusRule = sdbusplus::bus::match::rules;
21
Chris Cain78e86012021-03-04 16:15:31 -060022enum class CmdType
23{
24 POLL = 0x00,
25 CLEAR_ERROR_LOG = 0x12,
26 SET_MODE_AND_STATE = 0x20,
27 SET_CONFIG_DATA = 0x21,
28 SET_USER_PCAP = 0x22,
29 RESET_PREP = 0x25,
Chris Cain17257672021-10-22 13:41:03 -050030 SEND_AMBIENT = 0x30,
Chris Cain78e86012021-03-04 16:15:31 -060031 DEBUG_PASS_THROUGH = 0x40,
32 AME_PASS_THROUGH = 0x41,
33 GET_FIELD_DEBUG_DATA = 0x42,
34 MFG_TEST = 0x53
35};
36
37enum class OccState
38{
39 NO_CHANGE = 0x00,
40 STANDBY = 0x01,
41 OBSERVATION = 0x02,
42 ACTIVE = 0x03,
43 SAFE = 0x04,
Sheldon Bailey373af752022-02-21 15:14:00 -060044 CHARACTERIZATION = 0x05
Chris Cain78e86012021-03-04 16:15:31 -060045};
46
47enum class SysPwrMode
48{
49 NO_CHANGE = 0,
Chris Cain2ff28862024-01-31 10:21:13 -060050 STATIC = 0x01, // Static Base Frequencey
51 NON_DETERMINISTIC = 0x02, // Non-Deterministic
52 SFP = 0x03, // Static Frequency Point (requires freqPt)
Chris Cain78e86012021-03-04 16:15:31 -060053 SAFE = 0x04, // reported when system is in SAFE mode (not settable)
54 POWER_SAVING = 0x05, // Static Power Saving
Chris Cain2ff28862024-01-31 10:21:13 -060055 EFF_FAVOR_POWER = 0x06, // Efficiency - Favor Power
56 EFF_FAVOR_PERF = 0x07, // Efficiency - Favor Performance
57 MAX_FREQ = 0x09, // Maximum Frequency (per chip)
58 BALANCED_PERF = 0x0A, // Balanced Performance
59 FFO = 0x0B, // Fixed Frequency Override (requires freqPt)
60 MAX_PERF = 0x0C // Maximum Performance
Chris Cain78e86012021-03-04 16:15:31 -060061};
62
Eddie Jamesb3c57042022-11-15 14:00:08 -060063static inline auto format_as(SysPwrMode spm)
64{
65 return fmt::underlying(spm);
66}
67
Chris Cain78e86012021-03-04 16:15:31 -060068// Only some of the SysPwrModes are currently supported and allowed to be set
69#define VALID_POWER_MODE_SETTING(mode) \
Chris Cain36f9cde2021-11-22 11:18:21 -060070 ((mode == SysPwrMode::STATIC) || (mode == SysPwrMode::POWER_SAVING) || \
Chris Cain2ff28862024-01-31 10:21:13 -060071 (mode == SysPwrMode::BALANCED_PERF) || (mode == SysPwrMode::MAX_PERF) || \
72 (mode == SysPwrMode::EFF_FAVOR_POWER) || \
73 (mode == SysPwrMode::EFF_FAVOR_PERF))
Chris Cain36f9cde2021-11-22 11:18:21 -060074#define VALID_OEM_POWER_MODE_SETTING(mode) \
75 ((mode == SysPwrMode::SFP) || (mode == SysPwrMode::FFO) || \
Chris Cain2ff28862024-01-31 10:21:13 -060076 (mode == SysPwrMode::MAX_FREQ) || \
77 (mode == SysPwrMode::NON_DETERMINISTIC))
Chris Cain78e86012021-03-04 16:15:31 -060078
79enum class RspStatus
80{
81 SUCCESS = 0x00,
82 CONDITIONAL_SUCCESS = 0x01,
83 INVALID_COMMAND = 0x11,
84 INVALID_COMMAND_LENGTH = 0x12,
85 INVALID_DATA_FIELD = 0x13,
86 CHECKSUM_FAILURE = 0x14,
87 INTERNAL_ERROR = 0x15,
88 PRESENT_STATE_PROHIBITS = 0x16,
89 COMMAND_IN_PROGRESS = 0xFF
90};
91
Chris Caina8857c52021-01-27 11:53:05 -060092enum class CmdStatus
93{
Chris Cainc567dc82022-04-01 15:09:17 -050094 SUCCESS = 0x00,
95 FAILURE = 0x02,
96 COMM_FAILURE = 0x03
Chris Caina8857c52021-01-27 11:53:05 -060097};
98
Eddie Jamesb3c57042022-11-15 14:00:08 -060099static inline auto format_as(CmdStatus cs)
100{
101 return fmt::underlying(cs);
102}
103
Chris Caina8857c52021-01-27 11:53:05 -0600104/** @brief Trace block of data in hex with log<level:INFO>
105 *
106 * @param[in] data - vector containing data to trace
107 * @param[in] data_len - optional number of bytes to trace
108 * If 0, entire vector will be traced.
109 */
110void dump_hex(const std::vector<std::uint8_t>& data,
111 const unsigned int data_len = 0);
112
113/** @class OccCommand
114 * @brief Send commands and process respsonses from the OCC
115 */
116class OccCommand
117{
118 public:
119 OccCommand() = delete;
120 OccCommand(const OccCommand&) = delete;
121 OccCommand& operator=(const OccCommand&) = delete;
122 OccCommand(OccCommand&&) = default;
123 OccCommand& operator=(OccCommand&&) = default;
124
125 /** @brief Ctor to set up which OCC the command will go to
126 *
127 * @param[in] instance - OCC instance
Chris Caina8857c52021-01-27 11:53:05 -0600128 * @param[in] path - Path to attach at
129 */
George Liuf3b75142021-06-10 11:22:50 +0800130 OccCommand(uint8_t instance, const char* path);
Chris Caina8857c52021-01-27 11:53:05 -0600131
132 /** @brief Dtor to clean up and close device */
133 ~OccCommand()
134 {
135 closeDevice();
136 }
137
138 /** @brief Send the command to the OCC and collect the response.
139 * The checksum will be validated and removed from the response.
140 *
141 * @param[in] command - command to pass-through
142 * @param[out] response - response
143 * returns SUCCESS if response was received
144 */
145 CmdStatus send(const std::vector<std::uint8_t>& command,
146 std::vector<std::uint8_t>& response);
147
148 private:
149 /** @brief Instance number of the target OCC */
150 uint8_t occInstance;
151
152 /** @brief OCC path on the bus */
153 std::string path;
154
155 /** @brief OCC device path
156 * For now, here is the hard-coded mapping until
157 * the udev rule is in.
158 * occ0 --> /dev/occ1
159 * occ1 --> /dev/occ2
160 * ...
161 */
162 std::string devicePath;
163
164 /** @brief Indicates whether or not the OCC is currently active */
165 bool occActive = false;
166
167 /** brief file descriptor associated with occ device */
168 int fd = -1;
169
170 /** @brief Subscribe to OCC Status signal
171 *
172 * Once the OCC status gets to active, only then we will get /dev/occ2
173 * populated and hence need to wait on that before opening that
174 */
175 sdbusplus::bus::match_t activeStatusSignal;
176
177 /** Opens devicePath and populates file descriptor */
178 void openDevice();
179
180 /** Closed the fd associated with opened device */
181 void closeDevice();
182
183 /** @brief Callback function on OCC Status change signals
184 *
185 * @param[in] msg - Data associated with subscribed signal
186 */
Patrick Williamsaf408082022-07-22 19:26:54 -0500187 void activeStatusEvent(sdbusplus::message_t& msg);
Chris Caina8857c52021-01-27 11:53:05 -0600188};
189
190} // namespace occ
191} // namespace open_power