add dts config

hc

2023-12-06 08f87f769b595151be1afeff53e144f543faa614

 kernel/drivers/firmware/raspberrypi.c
..
..
@@ -1,15 +1,13 @@
1
+// SPDX-License-Identifier: GPL-2.0
1
2
 /*
2
3
  * Defines interfaces for interacting wtih the Raspberry Pi firmware's
3
4
  * property channel.
4
5
  *
5
6
  * Copyright © 2015 Broadcom
6
- *
7
- * This program is free software; you can redistribute it and/or modify
8
- * it under the terms of the GNU General Public License version 2 as
9
- * published by the Free Software Foundation.
10
7
  */
11
8
 
12
9
 #include <linux/dma-mapping.h>
10
+#include <linux/kref.h>
13
11
 #include <linux/mailbox_client.h>
14
12
 #include <linux/module.h>
15
13
 #include <linux/of_platform.h>
..
..
@@ -23,12 +21,15 @@
23
21
 #define MBOX_CHAN_PROPERTY		8
24
22
 
25
23
 static struct platform_device *rpi_hwmon;
24
+static struct platform_device *rpi_clk;
26
25
 
27
26
 struct rpi_firmware {
28
27
 	struct mbox_client cl;
29
28
 	struct mbox_chan *chan; /* The property channel. */
30
29
 	struct completion c;
31
30
 	u32 enabled;
31
+
32
+	struct kref consumers;
32
33
 };
33
34
 
34
35
 static DEFINE_MUTEX(transaction_lock);
..
..
@@ -55,8 +56,12 @@
55
56
 	reinit_completion(&fw->c);
56
57
 	ret = mbox_send_message(fw->chan, &message);
57
58
 	if (ret >= 0) {
58
-		wait_for_completion(&fw->c);
59
-		ret = 0;
59
+		if (wait_for_completion_timeout(&fw->c, HZ)) {
60
+			ret = 0;
61
+		} else {
62
+			ret = -ETIMEDOUT;
63
+			WARN_ONCE(1, "Firmware transaction timeout");
64
+		}
60
65
 	} else {
61
66
 		dev_err(fw->cl.dev, "mbox_send_message returned %d\n", ret);
62
67
 	}
..
..
@@ -175,21 +180,18 @@
175
180
 static void
176
181
 rpi_firmware_print_firmware_revision(struct rpi_firmware *fw)
177
182
 {
183
+	time64_t date_and_time;
178
184
 	u32 packet;
179
185
 	int ret = rpi_firmware_property(fw,
180
186
 					RPI_FIRMWARE_GET_FIRMWARE_REVISION,
181
187
 					&packet, sizeof(packet));
182
188
 
183
-	if (ret == 0) {
184
-		struct tm tm;
189
+	if (ret)
190
+		return;
185
191
 
186
-		time64_to_tm(packet, 0, &tm);
187
-
188
-		dev_info(fw->cl.dev,
189
-			 "Attached to firmware from %04ld-%02d-%02d %02d:%02d\n",
190
-			 tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday,
191
-			 tm.tm_hour, tm.tm_min);
192
-	}
192
+	/* This is not compatible with y2038 */
193
+	date_and_time = packet;
194
+	dev_info(fw->cl.dev, "Attached to firmware from %ptT\n", &date_and_time);
193
195
 }
194
196
 
195
197
 static void
..
..
@@ -206,12 +208,51 @@
206
208
 						  -1, NULL, 0);
207
209
 }
208
210
 
211
+static void rpi_register_clk_driver(struct device *dev)
212
+{
213
+	struct device_node *firmware;
214
+
215
+	/*
216
+	 * Earlier DTs don't have a node for the firmware clocks but
217
+	 * rely on us creating a platform device by hand. If we do
218
+	 * have a node for the firmware clocks, just bail out here.
219
+	 */
220
+	firmware = of_get_compatible_child(dev->of_node,
221
+					   "raspberrypi,firmware-clocks");
222
+	if (firmware) {
223
+		of_node_put(firmware);
224
+		return;
225
+	}
226
+
227
+	rpi_clk = platform_device_register_data(dev, "raspberrypi-clk",
228
+						-1, NULL, 0);
229
+}
230
+
231
+static void rpi_firmware_delete(struct kref *kref)
232
+{
233
+	struct rpi_firmware *fw = container_of(kref, struct rpi_firmware,
234
+					       consumers);
235
+
236
+	mbox_free_channel(fw->chan);
237
+	kfree(fw);
238
+}
239
+
240
+void rpi_firmware_put(struct rpi_firmware *fw)
241
+{
242
+	kref_put(&fw->consumers, rpi_firmware_delete);
243
+}
244
+EXPORT_SYMBOL_GPL(rpi_firmware_put);
245
+
209
246
 static int rpi_firmware_probe(struct platform_device *pdev)
210
247
 {
211
248
 	struct device *dev = &pdev->dev;
212
249
 	struct rpi_firmware *fw;
213
250
 
214
-	fw = devm_kzalloc(dev, sizeof(*fw), GFP_KERNEL);
251
+	/*
252
+	 * Memory will be freed by rpi_firmware_delete() once all users have
253
+	 * released their firmware handles. Don't use devm_kzalloc() here.
254
+	 */
255
+	fw = kzalloc(sizeof(*fw), GFP_KERNEL);
215
256
 	if (!fw)
216
257
 		return -ENOMEM;
217
258
 
..
..
@@ -228,13 +269,25 @@
228
269
 	}
229
270
 
230
271
 	init_completion(&fw->c);
272
+	kref_init(&fw->consumers);
231
273
 
232
274
 	platform_set_drvdata(pdev, fw);
233
275
 
234
276
 	rpi_firmware_print_firmware_revision(fw);
235
277
 	rpi_register_hwmon_driver(dev, fw);
278
+	rpi_register_clk_driver(dev);
236
279
 
237
280
 	return 0;
281
+}
282
+
283
+static void rpi_firmware_shutdown(struct platform_device *pdev)
284
+{
285
+	struct rpi_firmware *fw = platform_get_drvdata(pdev);
286
+
287
+	if (!fw)
288
+		return;
289
+
290
+	rpi_firmware_property(fw, RPI_FIRMWARE_NOTIFY_REBOOT, NULL, 0);
238
291
 }
239
292
 
240
293
 static int rpi_firmware_remove(struct platform_device *pdev)
..
..
@@ -243,7 +296,10 @@
243
296
 
244
297
 	platform_device_unregister(rpi_hwmon);
245
298
 	rpi_hwmon = NULL;
246
-	mbox_free_channel(fw->chan);
299
+	platform_device_unregister(rpi_clk);
300
+	rpi_clk = NULL;
301
+
302
+	rpi_firmware_put(fw);
247
303
 
248
304
 	return 0;
249
305
 }
..
..
@@ -252,16 +308,32 @@
252
308
  * rpi_firmware_get - Get pointer to rpi_firmware structure.
253
309
  * @firmware_node:    Pointer to the firmware Device Tree node.
254
310
  *
311
+ * The reference to rpi_firmware has to be released with rpi_firmware_put().
312
+ *
255
313
  * Returns NULL is the firmware device is not ready.
256
314
  */
257
315
 struct rpi_firmware *rpi_firmware_get(struct device_node *firmware_node)
258
316
 {
259
317
 	struct platform_device *pdev = of_find_device_by_node(firmware_node);
318
+	struct rpi_firmware *fw;
260
319
 
261
320
 	if (!pdev)
262
321
 		return NULL;
263
322
 
264
-	return platform_get_drvdata(pdev);
323
+	fw = platform_get_drvdata(pdev);
324
+	if (!fw)
325
+		goto err_put_device;
326
+
327
+	if (!kref_get_unless_zero(&fw->consumers))
328
+		goto err_put_device;
329
+
330
+	put_device(&pdev->dev);
331
+
332
+	return fw;
333
+
334
+err_put_device:
335
+	put_device(&pdev->dev);
336
+	return NULL;
265
337
 }
266
338
 EXPORT_SYMBOL_GPL(rpi_firmware_get);
267
339
 
..
..
@@ -277,6 +349,7 @@
277
349
 		.of_match_table = rpi_firmware_of_match,
278
350
 	},
279
351
 	.probe		= rpi_firmware_probe,
352
+	.shutdown	= rpi_firmware_shutdown,
280
353
 	.remove		= rpi_firmware_remove,
281
354
 };
282
355
 module_platform_driver(rpi_firmware_driver);