1 /*
2  * Copyright 2011 Red Hat Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: Ben Skeggs
23  */
24 #include "mxms.h"
25 
26 #include <core/option.h>
27 #include <subdev/bios.h>
28 #include <subdev/bios/mxm.h>
29 #include <subdev/i2c.h>
30 
31 static bool
32 mxm_shadow_rom_fetch(struct nvkm_i2c_port *i2c, u8 addr,
33 		     u8 offset, u8 size, u8 *data)
34 {
35 	struct i2c_msg msgs[] = {
36 		{ .addr = addr, .flags = 0, .len = 1, .buf = &offset },
37 		{ .addr = addr, .flags = I2C_M_RD, .len = size, .buf = data, },
38 	};
39 
40 	return i2c_transfer(&i2c->adapter, msgs, 2) == 2;
41 }
42 
43 static bool
44 mxm_shadow_rom(struct nvkm_mxm *mxm, u8 version)
45 {
46 	struct nvkm_bios *bios = nvkm_bios(mxm);
47 	struct nvkm_i2c *i2c = nvkm_i2c(mxm);
48 	struct nvkm_i2c_port *port = NULL;
49 	u8 i2cidx, mxms[6], addr, size;
50 
51 	i2cidx = mxm_ddc_map(bios, 1 /* LVDS_DDC */) & 0x0f;
52 	if (i2cidx < 0x0f)
53 		port = i2c->find(i2c, i2cidx);
54 	if (!port)
55 		return false;
56 
57 	addr = 0x54;
58 	if (!mxm_shadow_rom_fetch(port, addr, 0, 6, mxms)) {
59 		addr = 0x56;
60 		if (!mxm_shadow_rom_fetch(port, addr, 0, 6, mxms))
61 			return false;
62 	}
63 
64 	mxm->mxms = mxms;
65 	size = mxms_headerlen(mxm) + mxms_structlen(mxm);
66 	mxm->mxms = kmalloc(size, GFP_KERNEL);
67 
68 	if (mxm->mxms &&
69 	    mxm_shadow_rom_fetch(port, addr, 0, size, mxm->mxms))
70 		return true;
71 
72 	kfree(mxm->mxms);
73 	mxm->mxms = NULL;
74 	return false;
75 }
76 
77 #if defined(CONFIG_ACPI)
78 static bool
79 mxm_shadow_dsm(struct nvkm_mxm *mxm, u8 version)
80 {
81 	struct nvkm_device *device = nv_device(mxm);
82 	static char muid[] = {
83 		0x00, 0xA4, 0x04, 0x40, 0x7D, 0x91, 0xF2, 0x4C,
84 		0xB8, 0x9C, 0x79, 0xB6, 0x2F, 0xD5, 0x56, 0x65
85 	};
86 	u32 mxms_args[] = { 0x00000000 };
87 	union acpi_object argv4 = {
88 		.buffer.type = ACPI_TYPE_BUFFER,
89 		.buffer.length = sizeof(mxms_args),
90 		.buffer.pointer = (char *)mxms_args,
91 	};
92 	union acpi_object *obj;
93 	acpi_handle handle;
94 	int rev;
95 
96 	handle = ACPI_HANDLE(nv_device_base(device));
97 	if (!handle)
98 		return false;
99 
100 	/*
101 	 * spec says this can be zero to mean "highest revision", but
102 	 * of course there's at least one bios out there which fails
103 	 * unless you pass in exactly the version it supports..
104 	 */
105 	rev = (version & 0xf0) << 4 | (version & 0x0f);
106 	obj = acpi_evaluate_dsm(handle, muid, rev, 0x00000010, &argv4);
107 	if (!obj) {
108 		nv_debug(mxm, "DSM MXMS failed\n");
109 		return false;
110 	}
111 
112 	if (obj->type == ACPI_TYPE_BUFFER) {
113 		mxm->mxms = kmemdup(obj->buffer.pointer,
114 					 obj->buffer.length, GFP_KERNEL);
115 	} else if (obj->type == ACPI_TYPE_INTEGER) {
116 		nv_debug(mxm, "DSM MXMS returned 0x%llx\n", obj->integer.value);
117 	}
118 
119 	ACPI_FREE(obj);
120 	return mxm->mxms != NULL;
121 }
122 #endif
123 
124 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
125 
126 #define WMI_WMMX_GUID "F6CB5C3C-9CAE-4EBD-B577-931EA32A2CC0"
127 
128 static u8
129 wmi_wmmx_mxmi(struct nvkm_mxm *mxm, u8 version)
130 {
131 	u32 mxmi_args[] = { 0x494D584D /* MXMI */, version, 0 };
132 	struct acpi_buffer args = { sizeof(mxmi_args), mxmi_args };
133 	struct acpi_buffer retn = { ACPI_ALLOCATE_BUFFER, NULL };
134 	union acpi_object *obj;
135 	acpi_status status;
136 
137 	status = wmi_evaluate_method(WMI_WMMX_GUID, 0, 0, &args, &retn);
138 	if (ACPI_FAILURE(status)) {
139 		nv_debug(mxm, "WMMX MXMI returned %d\n", status);
140 		return 0x00;
141 	}
142 
143 	obj = retn.pointer;
144 	if (obj->type == ACPI_TYPE_INTEGER) {
145 		version = obj->integer.value;
146 		nv_debug(mxm, "WMMX MXMI version %d.%d\n",
147 			     (version >> 4), version & 0x0f);
148 	} else {
149 		version = 0;
150 		nv_debug(mxm, "WMMX MXMI returned non-integer\n");
151 	}
152 
153 	kfree(obj);
154 	return version;
155 }
156 
157 static bool
158 mxm_shadow_wmi(struct nvkm_mxm *mxm, u8 version)
159 {
160 	u32 mxms_args[] = { 0x534D584D /* MXMS */, version, 0 };
161 	struct acpi_buffer args = { sizeof(mxms_args), mxms_args };
162 	struct acpi_buffer retn = { ACPI_ALLOCATE_BUFFER, NULL };
163 	union acpi_object *obj;
164 	acpi_status status;
165 
166 	if (!wmi_has_guid(WMI_WMMX_GUID)) {
167 		nv_debug(mxm, "WMMX GUID not found\n");
168 		return false;
169 	}
170 
171 	mxms_args[1] = wmi_wmmx_mxmi(mxm, 0x00);
172 	if (!mxms_args[1])
173 		mxms_args[1] = wmi_wmmx_mxmi(mxm, version);
174 	if (!mxms_args[1])
175 		return false;
176 
177 	status = wmi_evaluate_method(WMI_WMMX_GUID, 0, 0, &args, &retn);
178 	if (ACPI_FAILURE(status)) {
179 		nv_debug(mxm, "WMMX MXMS returned %d\n", status);
180 		return false;
181 	}
182 
183 	obj = retn.pointer;
184 	if (obj->type == ACPI_TYPE_BUFFER) {
185 		mxm->mxms = kmemdup(obj->buffer.pointer,
186 				    obj->buffer.length, GFP_KERNEL);
187 	}
188 
189 	kfree(obj);
190 	return mxm->mxms != NULL;
191 }
192 #endif
193 
194 static struct mxm_shadow_h {
195 	const char *name;
196 	bool (*exec)(struct nvkm_mxm *, u8 version);
197 } _mxm_shadow[] = {
198 	{ "ROM", mxm_shadow_rom },
199 #if defined(CONFIG_ACPI)
200 	{ "DSM", mxm_shadow_dsm },
201 #endif
202 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
203 	{ "WMI", mxm_shadow_wmi },
204 #endif
205 	{}
206 };
207 
208 static int
209 mxm_shadow(struct nvkm_mxm *mxm, u8 version)
210 {
211 	struct mxm_shadow_h *shadow = _mxm_shadow;
212 	do {
213 		nv_debug(mxm, "checking %s\n", shadow->name);
214 		if (shadow->exec(mxm, version)) {
215 			if (mxms_valid(mxm))
216 				return 0;
217 			kfree(mxm->mxms);
218 			mxm->mxms = NULL;
219 		}
220 	} while ((++shadow)->name);
221 	return -ENOENT;
222 }
223 
224 int
225 nvkm_mxm_create_(struct nvkm_object *parent, struct nvkm_object *engine,
226 		 struct nvkm_oclass *oclass, int length, void **pobject)
227 {
228 	struct nvkm_device *device = nv_device(parent);
229 	struct nvkm_bios *bios = nvkm_bios(device);
230 	struct nvkm_mxm *mxm;
231 	u8  ver, len;
232 	u16 data;
233 	int ret;
234 
235 	ret = nvkm_subdev_create_(parent, engine, oclass, 0, "MXM", "mxm",
236 				  length, pobject);
237 	mxm = *pobject;
238 	if (ret)
239 		return ret;
240 
241 	data = mxm_table(bios, &ver, &len);
242 	if (!data || !(ver = nv_ro08(bios, data))) {
243 		nv_debug(mxm, "no VBIOS data, nothing to do\n");
244 		return 0;
245 	}
246 
247 	nv_info(mxm, "BIOS version %d.%d\n", ver >> 4, ver & 0x0f);
248 
249 	if (mxm_shadow(mxm, ver)) {
250 		nv_info(mxm, "failed to locate valid SIS\n");
251 #if 0
252 		/* we should, perhaps, fall back to some kind of limited
253 		 * mode here if the x86 vbios hasn't already done the
254 		 * work for us (so we prevent loading with completely
255 		 * whacked vbios tables).
256 		 */
257 		return -EINVAL;
258 #else
259 		return 0;
260 #endif
261 	}
262 
263 	nv_info(mxm, "MXMS Version %d.%d\n",
264 		mxms_version(mxm) >> 8, mxms_version(mxm) & 0xff);
265 	mxms_foreach(mxm, 0, NULL, NULL);
266 
267 	if (nvkm_boolopt(device->cfgopt, "NvMXMDCB", true))
268 		mxm->action |= MXM_SANITISE_DCB;
269 	return 0;
270 }
271