1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ */ 2*4882a593Smuzhiyun /* Copyright IBM Corp 2019 */ 3*4882a593Smuzhiyun 4*4882a593Smuzhiyun #ifndef OCC_COMMON_H 5*4882a593Smuzhiyun #define OCC_COMMON_H 6*4882a593Smuzhiyun 7*4882a593Smuzhiyun #include <linux/hwmon-sysfs.h> 8*4882a593Smuzhiyun #include <linux/mutex.h> 9*4882a593Smuzhiyun #include <linux/sysfs.h> 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun struct device; 12*4882a593Smuzhiyun 13*4882a593Smuzhiyun #define OCC_RESP_DATA_BYTES 4089 14*4882a593Smuzhiyun 15*4882a593Smuzhiyun /* 16*4882a593Smuzhiyun * Same response format for all OCC versions. 17*4882a593Smuzhiyun * Allocate the largest possible response. 18*4882a593Smuzhiyun */ 19*4882a593Smuzhiyun struct occ_response { 20*4882a593Smuzhiyun u8 seq_no; 21*4882a593Smuzhiyun u8 cmd_type; 22*4882a593Smuzhiyun u8 return_status; 23*4882a593Smuzhiyun __be16 data_length; 24*4882a593Smuzhiyun u8 data[OCC_RESP_DATA_BYTES]; 25*4882a593Smuzhiyun __be16 checksum; 26*4882a593Smuzhiyun } __packed; 27*4882a593Smuzhiyun 28*4882a593Smuzhiyun struct occ_sensor_data_block_header { 29*4882a593Smuzhiyun u8 eye_catcher[4]; 30*4882a593Smuzhiyun u8 reserved; 31*4882a593Smuzhiyun u8 sensor_format; 32*4882a593Smuzhiyun u8 sensor_length; 33*4882a593Smuzhiyun u8 num_sensors; 34*4882a593Smuzhiyun } __packed; 35*4882a593Smuzhiyun 36*4882a593Smuzhiyun struct occ_sensor_data_block { 37*4882a593Smuzhiyun struct occ_sensor_data_block_header header; 38*4882a593Smuzhiyun u32 data; 39*4882a593Smuzhiyun } __packed; 40*4882a593Smuzhiyun 41*4882a593Smuzhiyun struct occ_poll_response_header { 42*4882a593Smuzhiyun u8 status; 43*4882a593Smuzhiyun u8 ext_status; 44*4882a593Smuzhiyun u8 occs_present; 45*4882a593Smuzhiyun u8 config_data; 46*4882a593Smuzhiyun u8 occ_state; 47*4882a593Smuzhiyun u8 mode; 48*4882a593Smuzhiyun u8 ips_status; 49*4882a593Smuzhiyun u8 error_log_id; 50*4882a593Smuzhiyun __be32 error_log_start_address; 51*4882a593Smuzhiyun __be16 error_log_length; 52*4882a593Smuzhiyun u16 reserved; 53*4882a593Smuzhiyun u8 occ_code_level[16]; 54*4882a593Smuzhiyun u8 eye_catcher[6]; 55*4882a593Smuzhiyun u8 num_sensor_data_blocks; 56*4882a593Smuzhiyun u8 sensor_data_block_header_version; 57*4882a593Smuzhiyun } __packed; 58*4882a593Smuzhiyun 59*4882a593Smuzhiyun struct occ_poll_response { 60*4882a593Smuzhiyun struct occ_poll_response_header header; 61*4882a593Smuzhiyun struct occ_sensor_data_block block; 62*4882a593Smuzhiyun } __packed; 63*4882a593Smuzhiyun 64*4882a593Smuzhiyun struct occ_sensor { 65*4882a593Smuzhiyun u8 num_sensors; 66*4882a593Smuzhiyun u8 version; 67*4882a593Smuzhiyun void *data; /* pointer to sensor data start within response */ 68*4882a593Smuzhiyun }; 69*4882a593Smuzhiyun 70*4882a593Smuzhiyun /* 71*4882a593Smuzhiyun * OCC only provides one sensor data block of each type, but any number of 72*4882a593Smuzhiyun * sensors within that block. 73*4882a593Smuzhiyun */ 74*4882a593Smuzhiyun struct occ_sensors { 75*4882a593Smuzhiyun struct occ_sensor temp; 76*4882a593Smuzhiyun struct occ_sensor freq; 77*4882a593Smuzhiyun struct occ_sensor power; 78*4882a593Smuzhiyun struct occ_sensor caps; 79*4882a593Smuzhiyun struct occ_sensor extended; 80*4882a593Smuzhiyun }; 81*4882a593Smuzhiyun 82*4882a593Smuzhiyun /* 83*4882a593Smuzhiyun * Use our own attribute struct so we can dynamically allocate space for the 84*4882a593Smuzhiyun * name. 85*4882a593Smuzhiyun */ 86*4882a593Smuzhiyun struct occ_attribute { 87*4882a593Smuzhiyun char name[32]; 88*4882a593Smuzhiyun struct sensor_device_attribute_2 sensor; 89*4882a593Smuzhiyun }; 90*4882a593Smuzhiyun 91*4882a593Smuzhiyun struct occ { 92*4882a593Smuzhiyun struct device *bus_dev; 93*4882a593Smuzhiyun 94*4882a593Smuzhiyun struct occ_response resp; 95*4882a593Smuzhiyun struct occ_sensors sensors; 96*4882a593Smuzhiyun 97*4882a593Smuzhiyun int powr_sample_time_us; /* average power sample time */ 98*4882a593Smuzhiyun u8 seq_no; 99*4882a593Smuzhiyun u8 poll_cmd_data; /* to perform OCC poll command */ 100*4882a593Smuzhiyun int (*send_cmd)(struct occ *occ, u8 *cmd); 101*4882a593Smuzhiyun 102*4882a593Smuzhiyun unsigned long next_update; 103*4882a593Smuzhiyun struct mutex lock; /* lock OCC access */ 104*4882a593Smuzhiyun 105*4882a593Smuzhiyun struct device *hwmon; 106*4882a593Smuzhiyun struct occ_attribute *attrs; 107*4882a593Smuzhiyun struct attribute_group group; 108*4882a593Smuzhiyun const struct attribute_group *groups[2]; 109*4882a593Smuzhiyun 110*4882a593Smuzhiyun int error; /* final transfer error after retry */ 111*4882a593Smuzhiyun int last_error; /* latest transfer error */ 112*4882a593Smuzhiyun unsigned int error_count; /* number of xfr errors observed */ 113*4882a593Smuzhiyun unsigned long last_safe; /* time OCC entered "safe" state */ 114*4882a593Smuzhiyun 115*4882a593Smuzhiyun /* 116*4882a593Smuzhiyun * Store the previous state data for comparison in order to notify 117*4882a593Smuzhiyun * sysfs readers of state changes. 118*4882a593Smuzhiyun */ 119*4882a593Smuzhiyun int prev_error; 120*4882a593Smuzhiyun u8 prev_stat; 121*4882a593Smuzhiyun u8 prev_ext_stat; 122*4882a593Smuzhiyun u8 prev_occs_present; 123*4882a593Smuzhiyun }; 124*4882a593Smuzhiyun 125*4882a593Smuzhiyun int occ_setup(struct occ *occ, const char *name); 126*4882a593Smuzhiyun int occ_setup_sysfs(struct occ *occ); 127*4882a593Smuzhiyun void occ_shutdown(struct occ *occ); 128*4882a593Smuzhiyun void occ_sysfs_poll_done(struct occ *occ); 129*4882a593Smuzhiyun int occ_update_response(struct occ *occ); 130*4882a593Smuzhiyun 131*4882a593Smuzhiyun #endif /* OCC_COMMON_H */ 132