/* * Copyright (C) 2014 Satoshi Noguchi * Copyright (C) 2014 Synaptics Inc * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef _F54TEST_H_ #define _F54TEST_H_ #include "rmidevice.h" #define COMMAND_TIMEOUT_100MS 20 #define COMMAND_GET_REPORT 1 #define COMMAND_FORCE_CAL 2 #define COMMAND_FORCE_UPDATE 4 #define REPORT_INDEX_OFFSET 1 #define REPORT_DATA_OFFSET 3 #define SENSOR_RX_MAPPING_OFFSET 1 #define SENSOR_TX_MAPPING_OFFSET 2 #define CONTROL_0_SIZE 1 #define CONTROL_1_SIZE 1 #define CONTROL_2_SIZE 2 #define CONTROL_3_SIZE 1 #define CONTROL_4_6_SIZE 3 #define CONTROL_7_SIZE 1 #define CONTROL_8_9_SIZE 3 #define CONTROL_10_SIZE 1 #define CONTROL_11_SIZE 2 #define CONTROL_12_13_SIZE 2 #define CONTROL_14_SIZE 1 #define CONTROL_15_SIZE 1 #define CONTROL_16_SIZE 1 #define CONTROL_17_SIZE 1 #define CONTROL_18_SIZE 1 #define CONTROL_19_SIZE 1 #define CONTROL_20_SIZE 1 #define CONTROL_21_SIZE 2 #define CONTROL_22_26_SIZE 7 #define CONTROL_27_SIZE 1 #define CONTROL_28_SIZE 2 #define CONTROL_29_SIZE 1 #define CONTROL_30_SIZE 1 #define CONTROL_31_SIZE 1 #define CONTROL_32_35_SIZE 8 #define CONTROL_36_SIZE 1 #define CONTROL_37_SIZE 1 #define CONTROL_38_SIZE 1 #define CONTROL_39_SIZE 1 #define CONTROL_40_SIZE 1 #define CONTROL_41_SIZE 1 #define CONTROL_42_SIZE 2 #define CONTROL_43_54_SIZE 13 #define CONTROL_55_56_SIZE 2 #define CONTROL_57_SIZE 1 #define CONTROL_58_SIZE 1 #define CONTROL_59_SIZE 2 #define CONTROL_60_62_SIZE 3 #define CONTROL_63_SIZE 1 #define CONTROL_64_67_SIZE 4 #define CONTROL_68_73_SIZE 8 #define CONTROL_74_SIZE 2 #define CONTROL_75_SIZE 1 #define CONTROL_76_SIZE 1 #define CONTROL_77_78_SIZE 2 #define CONTROL_79_83_SIZE 5 #define CONTROL_84_85_SIZE 2 #define CONTROL_86_SIZE 1 #define CONTROL_87_SIZE 1 #define CONTROL_88_SIZE 1 #define CONTROL_89_SIZE 1 #define CONTROL_90_SIZE 1 #define CONTROL_91_SIZE 1 #define CONTROL_92_SIZE 1 #define CONTROL_93_SIZE 1 #define CONTROL_94_SIZE 1 #define CONTROL_95_SIZE 1 #define CONTROL_96_SIZE 1 #define CONTROL_97_SIZE 1 #define CONTROL_98_SIZE 1 #define CONTROL_99_SIZE 1 #define CONTROL_100_SIZE 1 #define CONTROL_101_SIZE 1 #define CONTROL_102_SIZE 1 #define CONTROL_103_SIZE 1 #define CONTROL_104_SIZE 1 #define CONTROL_105_SIZE 1 #define CONTROL_106_SIZE 1 #define CONTROL_107_SIZE 1 #define CONTROL_108_SIZE 1 #define CONTROL_109_SIZE 1 #define CONTROL_110_SIZE 1 #define CONTROL_111_SIZE 1 #define CONTROL_112_SIZE 1 #define CONTROL_113_SIZE 1 #define CONTROL_114_SIZE 1 #define CONTROL_115_SIZE 1 #define CONTROL_116_SIZE 1 #define CONTROL_117_SIZE 1 #define CONTROL_118_SIZE 1 #define CONTROL_119_SIZE 1 #define CONTROL_120_SIZE 1 #define CONTROL_121_SIZE 1 #define CONTROL_122_SIZE 1 #define CONTROL_123_SIZE 1 #define CONTROL_124_SIZE 1 #define CONTROL_125_SIZE 1 #define CONTROL_126_SIZE 1 #define CONTROL_127_SIZE 1 #define CONTROL_128_SIZE 1 #define CONTROL_129_SIZE 1 #define CONTROL_130_SIZE 1 #define CONTROL_131_SIZE 1 #define CONTROL_132_SIZE 1 #define CONTROL_133_SIZE 1 #define CONTROL_134_SIZE 1 #define CONTROL_135_SIZE 1 #define CONTROL_136_SIZE 1 #define CONTROL_137_SIZE 1 #define CONTROL_138_SIZE 1 #define CONTROL_139_SIZE 1 #define CONTROL_140_SIZE 1 #define CONTROL_141_SIZE 1 #define CONTROL_142_SIZE 1 #define CONTROL_143_SIZE 1 #define CONTROL_144_SIZE 1 #define CONTROL_145_SIZE 1 #define CONTROL_146_SIZE 1 #define CONTROL_147_SIZE 1 #define CONTROL_148_SIZE 1 #define CONTROL_149_SIZE 1 #define HIGH_RESISTANCE_DATA_SIZE 6 #define FULL_RAW_CAP_MIN_MAX_DATA_SIZE 4 #define TRX_OPEN_SHORT_DATA_SIZE 7 enum f54_report_types { F54_8BIT_IMAGE = 1, F54_16BIT_IMAGE = 2, F54_RAW_16BIT_IMAGE = 3, F54_HIGH_RESISTANCE = 4, F54_TX_TO_TX_SHORTS = 5, F54_RX_TO_RX_SHORTS_1 = 7, F54_TRUE_BASELINE = 9, F54_FULL_RAW_CAP_MIN_MAX = 13, F54_RX_OPENS_1 = 14, F54_TX_OPENS = 15, F54_TX_TO_GND_SHORTS = 16, F54_RX_TO_RX_SHORTS_2 = 17, F54_RX_OPENS_2 = 18, F54_FULL_RAW_CAP = 19, F54_FULL_RAW_CAP_NO_RX_COUPLING = 20, F54_SENSOR_SPEED = 22, F54_ADC_RANGE = 23, F54_TRX_OPENS = 24, F54_TRX_TO_GND_SHORTS = 25, F54_TRX_SHORTS = 26, F54_ABS_RAW_CAP = 38, F54_ABS_DELTA_CAP = 40, INVALID_REPORT_TYPE = -1, }; struct f54_query { union { struct { /* query 0 */ unsigned char num_of_rx_electrodes; /* query 1 */ unsigned char num_of_tx_electrodes; /* query 2 */ unsigned char f54_query2_b0__1:2; unsigned char has_baseline:1; unsigned char has_image8:1; unsigned char f54_query2_b4__5:2; unsigned char has_image16:1; unsigned char f54_query2_b7:1; /* queries 3.0 and 3.1 */ unsigned short clock_rate; /* query 4 */ unsigned char touch_controller_family; /* query 5 */ unsigned char has_pixel_touch_threshold_adjustment:1; unsigned char f54_query5_b1__7:7; /* query 6 */ unsigned char has_sensor_assignment:1; unsigned char has_interference_metric:1; unsigned char has_sense_frequency_control:1; unsigned char has_firmware_noise_mitigation:1; unsigned char has_ctrl11:1; unsigned char has_two_byte_report_rate:1; unsigned char has_one_byte_report_rate:1; unsigned char has_relaxation_control:1; /* query 7 */ unsigned char curve_compensation_mode:2; unsigned char f54_query7_b2__7:6; /* query 8 */ unsigned char f54_query8_b0:1; unsigned char has_iir_filter:1; unsigned char has_cmn_removal:1; unsigned char has_cmn_maximum:1; unsigned char has_touch_hysteresis:1; unsigned char has_edge_compensation:1; unsigned char has_per_frequency_noise_control:1; unsigned char has_enhanced_stretch:1; /* query 9 */ unsigned char has_force_fast_relaxation:1; unsigned char has_multi_metric_state_machine:1; unsigned char has_signal_clarity:1; unsigned char has_variance_metric:1; unsigned char has_0d_relaxation_control:1; unsigned char has_0d_acquisition_control:1; unsigned char has_status:1; unsigned char has_slew_metric:1; /* query 10 */ unsigned char has_h_blank:1; unsigned char has_v_blank:1; unsigned char has_long_h_blank:1; unsigned char has_startup_fast_relaxation:1; unsigned char has_esd_control:1; unsigned char has_noise_mitigation2:1; unsigned char has_noise_state:1; unsigned char has_energy_ratio_relaxation:1; /* query 11 */ unsigned char has_excessive_noise_reporting:1; unsigned char has_slew_option:1; unsigned char has_two_overhead_bursts:1; unsigned char has_query13:1; unsigned char has_one_overhead_burst:1; unsigned char f54_query11_b5:1; unsigned char has_ctrl88:1; unsigned char has_query15:1; /* query 12 */ unsigned char number_of_sensing_frequencies:4; unsigned char f54_query12_b4__7:4; } __attribute__((packed)); unsigned char data[14]; }; }; struct f54_query_13 { union { struct { unsigned char has_ctrl86:1; unsigned char has_ctrl87:1; unsigned char has_ctrl87_sub0:1; unsigned char has_ctrl87_sub1:1; unsigned char has_ctrl87_sub2:1; unsigned char has_cidim:1; unsigned char has_noise_mitigation_enhancement:1; unsigned char has_rail_im:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_15 { union { struct { unsigned char has_ctrl90:1; unsigned char has_transmit_strength:1; unsigned char has_ctrl87_sub3:1; unsigned char has_query16:1; unsigned char has_query20:1; unsigned char has_query21:1; unsigned char has_query22:1; unsigned char has_query25:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_16 { union { struct { unsigned char has_query17:1; unsigned char has_data17:1; unsigned char has_ctrl92:1; unsigned char has_ctrl93:1; unsigned char has_ctrl94_query18:1; unsigned char has_ctrl95_query19:1; unsigned char has_ctrl99:1; unsigned char has_ctrl100:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_21 { union { struct { unsigned char has_abs_rx:1; unsigned char has_abs_tx:1; unsigned char has_ctrl91:1; unsigned char has_ctrl96:1; unsigned char has_ctrl97:1; unsigned char has_ctrl98:1; unsigned char has_data19:1; unsigned char has_query24_data18:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_22 { union { struct { unsigned char has_packed_image:1; unsigned char has_ctrl101:1; unsigned char has_dynamic_sense_display_ratio:1; unsigned char has_query23:1; unsigned char has_ctrl103_query26:1; unsigned char has_ctrl104:1; unsigned char has_ctrl105:1; unsigned char has_query28:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_23 { union { struct { unsigned char has_ctrl102:1; unsigned char has_ctrl102_sub1:1; unsigned char has_ctrl102_sub2:1; unsigned char has_ctrl102_sub4:1; unsigned char has_ctrl102_sub5:1; unsigned char has_ctrl102_sub9:1; unsigned char has_ctrl102_sub10:1; unsigned char has_ctrl102_sub11:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_25 { union { struct { unsigned char has_ctrl106:1; unsigned char has_ctrl102_sub12:1; unsigned char has_ctrl107:1; unsigned char has_ctrl108:1; unsigned char has_ctrl109:1; unsigned char has_data20:1; unsigned char f54_query25_b6:1; unsigned char has_query27:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_27 { union { struct { unsigned char has_ctrl110:1; unsigned char has_data21:1; unsigned char has_ctrl111:1; unsigned char has_ctrl112:1; unsigned char has_ctrl113:1; unsigned char has_data22:1; unsigned char has_ctrl114:1; unsigned char has_query29:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_29 { union { struct { unsigned char has_ctrl115:1; unsigned char has_ground_ring_options:1; unsigned char has_lost_bursts_tuning:1; unsigned char has_aux_exvcom2_select:1; unsigned char has_ctrl116:1; unsigned char has_data23:1; unsigned char has_ctrl117:1; unsigned char has_query30:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_30 { union { struct { unsigned char has_ctrl118:1; unsigned char has_ctrl119:1; unsigned char has_ctrl120:1; unsigned char has_ctrl121:1; unsigned char has_ctrl122_query31:1; unsigned char has_ctrl123:1; unsigned char f54_query30_b6:1; unsigned char has_query32:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_32 { union { struct { unsigned char has_ctrl125:1; unsigned char has_ctrl126:1; unsigned char has_ctrl127:1; unsigned char has_abs_charge_pump_disable:1; unsigned char has_query33:1; unsigned char has_data24:1; unsigned char has_query34:1; unsigned char has_query35:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_33 { union { struct { unsigned char f54_query33_b0:1; unsigned char f54_query33_b1:1; unsigned char f54_query33_b2:1; unsigned char f54_query33_b3:1; unsigned char has_ctrl132:1; unsigned char has_ctrl133:1; unsigned char has_ctrl134:1; unsigned char has_query36:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_35 { union { struct { unsigned char has_data25:1; unsigned char f54_query35_b1:1; unsigned char f54_query35_b2:1; unsigned char has_ctrl137:1; unsigned char has_ctrl138:1; unsigned char has_ctrl139:1; unsigned char has_data26:1; unsigned char has_ctrl140:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_36 { union { struct { unsigned char f54_query36_b0:1; unsigned char has_ctrl142:1; unsigned char has_query37:1; unsigned char has_ctrl143:1; unsigned char has_ctrl144:1; unsigned char has_ctrl145:1; unsigned char has_ctrl146:1; unsigned char has_query38:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_query_38 { union { struct { unsigned char has_ctrl147:1; unsigned char has_ctrl148:1; unsigned char has_ctrl149:1; unsigned char f54_query38_b3:1; unsigned char f54_query38_b4:1; unsigned char f54_query38_b5:1; unsigned char f54_query38_b6:1; unsigned char f54_query38_b7:1; } __attribute__((packed)); unsigned char data[1]; }; }; struct f54_control_7 { union { struct { unsigned char cbc_cap:3; unsigned char cbc_polarity:1; unsigned char cbc_tx_carrier_selection:1; unsigned char f54_ctrl7_b5__7:3; } __attribute__((packed)); struct { unsigned char data[1]; unsigned short address; } __attribute__((packed)); }; }; struct f54_control_41 { union { struct { unsigned char no_signal_clarity:1; unsigned char f54_ctrl41_b1__7:7; } __attribute__((packed)); struct { unsigned char data[1]; unsigned short address; } __attribute__((packed)); }; }; struct f54_control_57 { union { struct { unsigned char cbc_cap:3; unsigned char cbc_polarity:1; unsigned char cbc_tx_carrier_selection:1; unsigned char f54_ctrl57_b5__7:3; } __attribute__((packed)); struct { unsigned char data[1]; unsigned short address; } __attribute__((packed)); }; }; struct f54_control_88 { union { struct { unsigned char tx_low_reference_polarity:1; unsigned char tx_high_reference_polarity:1; unsigned char abs_low_reference_polarity:1; unsigned char abs_polarity:1; unsigned char cbc_polarity:1; unsigned char cbc_tx_carrier_selection:1; unsigned char charge_pump_enable:1; unsigned char cbc_abs_auto_servo:1; } __attribute__((packed)); struct { unsigned char data[1]; unsigned short address; } __attribute__((packed)); }; }; struct f54_control_110 { union { struct { unsigned char active_stylus_rx_feedback_cap; unsigned char active_stylus_rx_feedback_cap_reference; unsigned char active_stylus_low_reference; unsigned char active_stylus_high_reference; unsigned char active_stylus_gain_control; unsigned char active_stylus_gain_control_reference; unsigned char active_stylus_timing_mode; unsigned char active_stylus_discovery_bursts; unsigned char active_stylus_detection_bursts; unsigned char active_stylus_discovery_noise_multiplier; unsigned char active_stylus_detection_envelope_min; unsigned char active_stylus_detection_envelope_max; unsigned char active_stylus_lose_count; } __attribute__((packed)); struct { unsigned char data[13]; unsigned short address; } __attribute__((packed)); }; }; struct f54_control_149 { union { struct { unsigned char trans_cbc_global_cap_enable:1; unsigned char f54_ctrl49_b1__7:7; } __attribute__((packed)); struct { unsigned char data[1]; unsigned short address; } __attribute__((packed)); }; }; struct f54_control { struct f54_control_7 reg_7; struct f54_control_41 reg_41; struct f54_control_57 reg_57; struct f54_control_88 reg_88; struct f54_control_110 reg_110; struct f54_control_149 reg_149; }; struct f55_query { union { struct { /* query 0 */ unsigned char num_of_rx_electrodes; /* query 1 */ unsigned char num_of_tx_electrodes; /* query 2 */ unsigned char has_sensor_assignment:1; unsigned char has_edge_compensation:1; unsigned char curve_compensation_mode:2; unsigned char has_ctrl6:1; unsigned char has_alternate_transmitter_assignment:1; unsigned char has_single_layer_multi_touch:1; unsigned char has_query5:1; } __attribute__((packed)); unsigned char data[3]; }; }; class Display; class F54Test { public: F54Test(RMIDevice & device, Display & display) : m_device(device), m_reportType(INVALID_REPORT_TYPE), m_txAssignment(NULL), m_rxAssignment(NULL), m_reportBufferSize(0), m_reportData(NULL), m_display(display) {} ~F54Test(); int Prepare(f54_report_types reportType); int Run(); private: int FindTestFunctions(); int ReadF54Queries(); int ReadF55Queries(); int SetupF54Controls(); int SetF54ReportType(f54_report_types report_type); int SetF54ReportSize(f54_report_types report_type); int SetF54Interrupt(); int DoF54Command(unsigned char command); int WaitForF54CommandCompletion(); int ReadF54Report(); int ShowF54Report(); private: RMIDevice & m_device; RMIFunction m_f01; RMIFunction m_f54; RMIFunction m_f55; f54_query m_f54Query; f54_query_13 m_f54Query_13; f54_query_15 m_f54Query_15; f54_query_16 m_f54Query_16; f54_query_21 m_f54Query_21; f54_query_22 m_f54Query_22; f54_query_23 m_f54Query_23; f54_query_25 m_f54Query_25; f54_query_27 m_f54Query_27; f54_query_29 m_f54Query_29; f54_query_30 m_f54Query_30; f54_query_32 m_f54Query_32; f54_query_33 m_f54Query_33; f54_query_35 m_f54Query_35; f54_query_36 m_f54Query_36; f54_query_38 m_f54Query_38; f54_control m_f54Control; f55_query m_f55Query; f54_report_types m_reportType; unsigned int m_reportSize; unsigned char *m_txAssignment; unsigned char *m_rxAssignment; unsigned char m_txAssigned; unsigned char m_rxAssigned; unsigned int m_reportBufferSize; unsigned char *m_reportData; Display & m_display; }; #endif // _F54TEST_H_