xref: /linux/drivers/net/phy/open_alliance_helpers.h (revision 9410645520e9b820069761f3450ef6661418e279)
1*9e7c1a9bSOleksij Rempel /* SPDX-License-Identifier: GPL-2.0 */
2*9e7c1a9bSOleksij Rempel 
3*9e7c1a9bSOleksij Rempel #ifndef OPEN_ALLIANCE_HELPERS_H
4*9e7c1a9bSOleksij Rempel #define OPEN_ALLIANCE_HELPERS_H
5*9e7c1a9bSOleksij Rempel 
6*9e7c1a9bSOleksij Rempel /*
7*9e7c1a9bSOleksij Rempel  * These defines reflect the TDR (Time Delay Reflection) diagnostic feature
8*9e7c1a9bSOleksij Rempel  * for 1000BASE-T1 automotive Ethernet PHYs as specified by the OPEN Alliance.
9*9e7c1a9bSOleksij Rempel  *
10*9e7c1a9bSOleksij Rempel  * The register values are part of the HDD.TDR register, which provides
11*9e7c1a9bSOleksij Rempel  * information about the cable status and faults. The exact register offset
12*9e7c1a9bSOleksij Rempel  * is device-specific and should be provided by the driver.
13*9e7c1a9bSOleksij Rempel  */
14*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_ACTIVATION_MASK		GENMASK(1, 0)
15*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_ACTIVATION_OFF		1
16*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_ACTIVATION_ON		2
17*9e7c1a9bSOleksij Rempel 
18*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_STATUS_MASK			GENMASK(7, 4)
19*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_STATUS_SHORT			3
20*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_STATUS_OPEN			6
21*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_STATUS_NOISE			5
22*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_STATUS_CABLE_OK		7
23*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_STATUS_TEST_IN_PROGRESS	8
24*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_STATUS_TEST_NOT_POSSIBLE	13
25*9e7c1a9bSOleksij Rempel 
26*9e7c1a9bSOleksij Rempel /*
27*9e7c1a9bSOleksij Rempel  * OA_1000BT1_HDD_TDR_DISTANCE_MASK:
28*9e7c1a9bSOleksij Rempel  * This mask is used to extract the distance to the first/main fault
29*9e7c1a9bSOleksij Rempel  * detected by the TDR feature. Each bit represents an approximate distance
30*9e7c1a9bSOleksij Rempel  * of 1 meter, ranging from 0 to 31 meters. The exact interpretation of the
31*9e7c1a9bSOleksij Rempel  * bits may vary, but generally:
32*9e7c1a9bSOleksij Rempel  * 000000 = no error
33*9e7c1a9bSOleksij Rempel  * 000001 = error about 0-1m away
34*9e7c1a9bSOleksij Rempel  * 000010 = error between 1-2m away
35*9e7c1a9bSOleksij Rempel  * ...
36*9e7c1a9bSOleksij Rempel  * 011111 = error about 30-31m away
37*9e7c1a9bSOleksij Rempel  * 111111 = resolution not possible / out of distance
38*9e7c1a9bSOleksij Rempel  */
39*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_DISTANCE_MASK			GENMASK(13, 8)
40*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_DISTANCE_NO_ERROR			0
41*9e7c1a9bSOleksij Rempel #define OA_1000BT1_HDD_TDR_DISTANCE_RESOLUTION_NOT_POSSIBLE	0x3f
42*9e7c1a9bSOleksij Rempel 
43*9e7c1a9bSOleksij Rempel int oa_1000bt1_get_ethtool_cable_result_code(u16 reg_value);
44*9e7c1a9bSOleksij Rempel int oa_1000bt1_get_tdr_distance(u16 reg_value);
45*9e7c1a9bSOleksij Rempel 
46*9e7c1a9bSOleksij Rempel #endif /* OPEN_ALLIANCE_HELPERS_H */
47*9e7c1a9bSOleksij Rempel 
48