xref: /OK3568_Linux_fs/kernel/drivers/media/pci/ttpci/ttpci-eeprom.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun     Retrieve encoded MAC address from 24C16 serial 2-wire EEPROM,
4*4882a593Smuzhiyun     decode it and store it in the associated adapter struct for
5*4882a593Smuzhiyun     use by dvb_net.c
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun     This card appear to have the 24C16 write protect held to ground,
8*4882a593Smuzhiyun     thus permitting normal read/write operation. Theoretically it
9*4882a593Smuzhiyun     would be possible to write routines to burn a different (encoded)
10*4882a593Smuzhiyun     MAC address into the EEPROM.
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun     Robert Schlabbach	GMX
13*4882a593Smuzhiyun     Michael Glaum	KVH Industries
14*4882a593Smuzhiyun     Holger Waechtler	Convergence
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun     Copyright (C) 2002-2003 Ralph Metzler <rjkm@metzlerbros.de>
17*4882a593Smuzhiyun 			    Metzler Brothers Systementwicklung GbR
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun */
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #include <asm/errno.h>
23*4882a593Smuzhiyun #include <linux/init.h>
24*4882a593Smuzhiyun #include <linux/module.h>
25*4882a593Smuzhiyun #include <linux/string.h>
26*4882a593Smuzhiyun #include <linux/i2c.h>
27*4882a593Smuzhiyun #include <linux/etherdevice.h>
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun #include "ttpci-eeprom.h"
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun #if 1
32*4882a593Smuzhiyun #define dprintk(x...) do { printk(x); } while (0)
33*4882a593Smuzhiyun #else
34*4882a593Smuzhiyun #define dprintk(x...) do { } while (0)
35*4882a593Smuzhiyun #endif
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun 
check_mac_tt(u8 * buf)38*4882a593Smuzhiyun static int check_mac_tt(u8 *buf)
39*4882a593Smuzhiyun {
40*4882a593Smuzhiyun 	int i;
41*4882a593Smuzhiyun 	u16 tmp = 0xffff;
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun 	for (i = 0; i < 8; i++) {
44*4882a593Smuzhiyun 		tmp  = (tmp << 8) | ((tmp >> 8) ^ buf[i]);
45*4882a593Smuzhiyun 		tmp ^= (tmp >> 4) & 0x0f;
46*4882a593Smuzhiyun 		tmp ^= (tmp << 12) ^ ((tmp & 0xff) << 5);
47*4882a593Smuzhiyun 	}
48*4882a593Smuzhiyun 	tmp ^= 0xffff;
49*4882a593Smuzhiyun 	return (((tmp >> 8) ^ buf[8]) | ((tmp & 0xff) ^ buf[9]));
50*4882a593Smuzhiyun }
51*4882a593Smuzhiyun 
getmac_tt(u8 * decodedMAC,u8 * encodedMAC)52*4882a593Smuzhiyun static int getmac_tt(u8 * decodedMAC, u8 * encodedMAC)
53*4882a593Smuzhiyun {
54*4882a593Smuzhiyun 	u8 xor[20] = { 0x72, 0x23, 0x68, 0x19, 0x5c, 0xa8, 0x71, 0x2c,
55*4882a593Smuzhiyun 		       0x54, 0xd3, 0x7b, 0xf1, 0x9E, 0x23, 0x16, 0xf6,
56*4882a593Smuzhiyun 		       0x1d, 0x36, 0x64, 0x78};
57*4882a593Smuzhiyun 	u8 data[20];
58*4882a593Smuzhiyun 	int i;
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	/* In case there is a sig check failure have the orig contents available */
61*4882a593Smuzhiyun 	memcpy(data, encodedMAC, 20);
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun 	for (i = 0; i < 20; i++)
64*4882a593Smuzhiyun 		data[i] ^= xor[i];
65*4882a593Smuzhiyun 	for (i = 0; i < 10; i++)
66*4882a593Smuzhiyun 		data[i] = ((data[2 * i + 1] << 8) | data[2 * i])
67*4882a593Smuzhiyun 			>> ((data[2 * i + 1] >> 6) & 3);
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun 	if (check_mac_tt(data))
70*4882a593Smuzhiyun 		return -ENODEV;
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun 	decodedMAC[0] = data[2]; decodedMAC[1] = data[1]; decodedMAC[2] = data[0];
73*4882a593Smuzhiyun 	decodedMAC[3] = data[6]; decodedMAC[4] = data[5]; decodedMAC[5] = data[4];
74*4882a593Smuzhiyun 	return 0;
75*4882a593Smuzhiyun }
76*4882a593Smuzhiyun 
ttpci_eeprom_decode_mac(u8 * decodedMAC,u8 * encodedMAC)77*4882a593Smuzhiyun int ttpci_eeprom_decode_mac(u8 *decodedMAC, u8 *encodedMAC)
78*4882a593Smuzhiyun {
79*4882a593Smuzhiyun 	u8 xor[20] = { 0x72, 0x23, 0x68, 0x19, 0x5c, 0xa8, 0x71, 0x2c,
80*4882a593Smuzhiyun 		       0x54, 0xd3, 0x7b, 0xf1, 0x9E, 0x23, 0x16, 0xf6,
81*4882a593Smuzhiyun 		       0x1d, 0x36, 0x64, 0x78};
82*4882a593Smuzhiyun 	u8 data[20];
83*4882a593Smuzhiyun 	int i;
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun 	memcpy(data, encodedMAC, 20);
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun 	for (i = 0; i < 20; i++)
88*4882a593Smuzhiyun 		data[i] ^= xor[i];
89*4882a593Smuzhiyun 	for (i = 0; i < 10; i++)
90*4882a593Smuzhiyun 		data[i] = ((data[2 * i + 1] << 8) | data[2 * i])
91*4882a593Smuzhiyun 			>> ((data[2 * i + 1] >> 6) & 3);
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun 	if (check_mac_tt(data))
94*4882a593Smuzhiyun 		return -ENODEV;
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun 	decodedMAC[0] = data[2];
97*4882a593Smuzhiyun 	decodedMAC[1] = data[1];
98*4882a593Smuzhiyun 	decodedMAC[2] = data[0];
99*4882a593Smuzhiyun 	decodedMAC[3] = data[6];
100*4882a593Smuzhiyun 	decodedMAC[4] = data[5];
101*4882a593Smuzhiyun 	decodedMAC[5] = data[4];
102*4882a593Smuzhiyun 	return 0;
103*4882a593Smuzhiyun }
104*4882a593Smuzhiyun EXPORT_SYMBOL(ttpci_eeprom_decode_mac);
105*4882a593Smuzhiyun 
ttpci_eeprom_read_encodedMAC(struct i2c_adapter * adapter,u8 * encodedMAC)106*4882a593Smuzhiyun static int ttpci_eeprom_read_encodedMAC(struct i2c_adapter *adapter, u8 * encodedMAC)
107*4882a593Smuzhiyun {
108*4882a593Smuzhiyun 	int ret;
109*4882a593Smuzhiyun 	u8 b0[] = { 0xcc };
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun 	struct i2c_msg msg[] = {
112*4882a593Smuzhiyun 		{ .addr = 0x50, .flags = 0, .buf = b0, .len = 1 },
113*4882a593Smuzhiyun 		{ .addr = 0x50, .flags = I2C_M_RD, .buf = encodedMAC, .len = 20 }
114*4882a593Smuzhiyun 	};
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun 	/* dprintk("%s\n", __func__); */
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun 	ret = i2c_transfer(adapter, msg, 2);
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun 	if (ret != 2)		/* Assume EEPROM isn't there */
121*4882a593Smuzhiyun 		return (-ENODEV);
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun 	return 0;
124*4882a593Smuzhiyun }
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun 
ttpci_eeprom_parse_mac(struct i2c_adapter * adapter,u8 * proposed_mac)127*4882a593Smuzhiyun int ttpci_eeprom_parse_mac(struct i2c_adapter *adapter, u8 *proposed_mac)
128*4882a593Smuzhiyun {
129*4882a593Smuzhiyun 	int ret;
130*4882a593Smuzhiyun 	u8 encodedMAC[20];
131*4882a593Smuzhiyun 	u8 decodedMAC[6];
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	ret = ttpci_eeprom_read_encodedMAC(adapter, encodedMAC);
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun 	if (ret != 0) {		/* Will only be -ENODEV */
136*4882a593Smuzhiyun 		dprintk("Couldn't read from EEPROM: not there?\n");
137*4882a593Smuzhiyun 		eth_zero_addr(proposed_mac);
138*4882a593Smuzhiyun 		return ret;
139*4882a593Smuzhiyun 	}
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun 	ret = getmac_tt(decodedMAC, encodedMAC);
142*4882a593Smuzhiyun 	if( ret != 0 ) {
143*4882a593Smuzhiyun 		dprintk("adapter failed MAC signature check\n");
144*4882a593Smuzhiyun 		dprintk("encoded MAC from EEPROM was %*phC",
145*4882a593Smuzhiyun 			(int)sizeof(encodedMAC), &encodedMAC);
146*4882a593Smuzhiyun 		eth_zero_addr(proposed_mac);
147*4882a593Smuzhiyun 		return ret;
148*4882a593Smuzhiyun 	}
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun 	memcpy(proposed_mac, decodedMAC, 6);
151*4882a593Smuzhiyun 	dprintk("adapter has MAC addr = %pM\n", decodedMAC);
152*4882a593Smuzhiyun 	return 0;
153*4882a593Smuzhiyun }
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun EXPORT_SYMBOL(ttpci_eeprom_parse_mac);
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun MODULE_LICENSE("GPL");
158*4882a593Smuzhiyun MODULE_AUTHOR("Ralph Metzler, Marcus Metzler, others");
159*4882a593Smuzhiyun MODULE_DESCRIPTION("Decode dvb_net MAC address from EEPROM of PCI DVB cards made by Siemens, Technotrend, Hauppauge");
160