1f1e1ea51SMario Limonciello // SPDX-License-Identifier: GPL-2.0-only
2f1e1ea51SMario Limonciello /*
3f1e1ea51SMario Limonciello * dell_rbu.c
4f1e1ea51SMario Limonciello * Bios Update driver for Dell systems
5f1e1ea51SMario Limonciello * Author: Dell Inc
6f1e1ea51SMario Limonciello * Abhay Salunke <abhay_salunke@dell.com>
7f1e1ea51SMario Limonciello *
8f1e1ea51SMario Limonciello * Copyright (C) 2005 Dell Inc.
9f1e1ea51SMario Limonciello *
10f1e1ea51SMario Limonciello * Remote BIOS Update (rbu) driver is used for updating DELL BIOS by
11f1e1ea51SMario Limonciello * creating entries in the /sys file systems on Linux 2.6 and higher
12f1e1ea51SMario Limonciello * kernels. The driver supports two mechanism to update the BIOS namely
13f1e1ea51SMario Limonciello * contiguous and packetized. Both these methods still require having some
14f1e1ea51SMario Limonciello * application to set the CMOS bit indicating the BIOS to update itself
15f1e1ea51SMario Limonciello * after a reboot.
16f1e1ea51SMario Limonciello *
17f1e1ea51SMario Limonciello * Contiguous method:
18f1e1ea51SMario Limonciello * This driver writes the incoming data in a monolithic image by allocating
19f1e1ea51SMario Limonciello * contiguous physical pages large enough to accommodate the incoming BIOS
20f1e1ea51SMario Limonciello * image size.
21f1e1ea51SMario Limonciello *
22f1e1ea51SMario Limonciello * Packetized method:
23f1e1ea51SMario Limonciello * The driver writes the incoming packet image by allocating a new packet
24f1e1ea51SMario Limonciello * on every time the packet data is written. This driver requires an
25f1e1ea51SMario Limonciello * application to break the BIOS image in to fixed sized packet chunks.
26f1e1ea51SMario Limonciello *
27f1e1ea51SMario Limonciello * See Documentation/admin-guide/dell_rbu.rst for more info.
28f1e1ea51SMario Limonciello */
29f1e1ea51SMario Limonciello
30f1e1ea51SMario Limonciello #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31f1e1ea51SMario Limonciello
32f1e1ea51SMario Limonciello #include <linux/init.h>
33f1e1ea51SMario Limonciello #include <linux/module.h>
34f1e1ea51SMario Limonciello #include <linux/slab.h>
35f1e1ea51SMario Limonciello #include <linux/string.h>
36f1e1ea51SMario Limonciello #include <linux/errno.h>
37f1e1ea51SMario Limonciello #include <linux/blkdev.h>
38f1e1ea51SMario Limonciello #include <linux/platform_device.h>
39f1e1ea51SMario Limonciello #include <linux/spinlock.h>
40f1e1ea51SMario Limonciello #include <linux/moduleparam.h>
41f1e1ea51SMario Limonciello #include <linux/firmware.h>
42f1e1ea51SMario Limonciello #include <linux/dma-mapping.h>
43f1e1ea51SMario Limonciello #include <asm/set_memory.h>
44f1e1ea51SMario Limonciello
45f1e1ea51SMario Limonciello MODULE_AUTHOR("Abhay Salunke <abhay_salunke@dell.com>");
46f1e1ea51SMario Limonciello MODULE_DESCRIPTION("Driver for updating BIOS image on DELL systems");
47f1e1ea51SMario Limonciello MODULE_LICENSE("GPL");
48f1e1ea51SMario Limonciello MODULE_VERSION("3.2");
49f1e1ea51SMario Limonciello
50f1e1ea51SMario Limonciello #define BIOS_SCAN_LIMIT 0xffffffff
51f1e1ea51SMario Limonciello #define MAX_IMAGE_LENGTH 16
52f1e1ea51SMario Limonciello static struct _rbu_data {
53f1e1ea51SMario Limonciello void *image_update_buffer;
54f1e1ea51SMario Limonciello unsigned long image_update_buffer_size;
55f1e1ea51SMario Limonciello unsigned long bios_image_size;
56f1e1ea51SMario Limonciello int image_update_ordernum;
57f1e1ea51SMario Limonciello spinlock_t lock;
58f1e1ea51SMario Limonciello unsigned long packet_read_count;
59f1e1ea51SMario Limonciello unsigned long num_packets;
60f1e1ea51SMario Limonciello unsigned long packetsize;
61f1e1ea51SMario Limonciello unsigned long imagesize;
62f1e1ea51SMario Limonciello int entry_created;
63f1e1ea51SMario Limonciello } rbu_data;
64f1e1ea51SMario Limonciello
65f1e1ea51SMario Limonciello static char image_type[MAX_IMAGE_LENGTH + 1] = "mono";
66f1e1ea51SMario Limonciello module_param_string(image_type, image_type, sizeof (image_type), 0);
67f1e1ea51SMario Limonciello MODULE_PARM_DESC(image_type, "BIOS image type. choose- mono or packet or init");
68f1e1ea51SMario Limonciello
69f1e1ea51SMario Limonciello static unsigned long allocation_floor = 0x100000;
70f1e1ea51SMario Limonciello module_param(allocation_floor, ulong, 0644);
71f1e1ea51SMario Limonciello MODULE_PARM_DESC(allocation_floor, "Minimum address for allocations when using Packet mode");
72f1e1ea51SMario Limonciello
73f1e1ea51SMario Limonciello struct packet_data {
74f1e1ea51SMario Limonciello struct list_head list;
75f1e1ea51SMario Limonciello size_t length;
76f1e1ea51SMario Limonciello void *data;
77f1e1ea51SMario Limonciello int ordernum;
78f1e1ea51SMario Limonciello };
79f1e1ea51SMario Limonciello
80f1e1ea51SMario Limonciello static struct packet_data packet_data_head;
81f1e1ea51SMario Limonciello
82f1e1ea51SMario Limonciello static struct platform_device *rbu_device;
83f1e1ea51SMario Limonciello static int context;
84f1e1ea51SMario Limonciello
init_packet_head(void)85f1e1ea51SMario Limonciello static void init_packet_head(void)
86f1e1ea51SMario Limonciello {
87f1e1ea51SMario Limonciello INIT_LIST_HEAD(&packet_data_head.list);
88f1e1ea51SMario Limonciello rbu_data.packet_read_count = 0;
89f1e1ea51SMario Limonciello rbu_data.num_packets = 0;
90f1e1ea51SMario Limonciello rbu_data.packetsize = 0;
91f1e1ea51SMario Limonciello rbu_data.imagesize = 0;
92f1e1ea51SMario Limonciello }
93f1e1ea51SMario Limonciello
create_packet(void * data,size_t length)94f1e1ea51SMario Limonciello static int create_packet(void *data, size_t length)
95f1e1ea51SMario Limonciello {
96f1e1ea51SMario Limonciello struct packet_data *newpacket;
97f1e1ea51SMario Limonciello int ordernum = 0;
98f1e1ea51SMario Limonciello int retval = 0;
99f1e1ea51SMario Limonciello unsigned int packet_array_size = 0;
100f1e1ea51SMario Limonciello void **invalid_addr_packet_array = NULL;
101f1e1ea51SMario Limonciello void *packet_data_temp_buf = NULL;
102f1e1ea51SMario Limonciello unsigned int idx = 0;
103f1e1ea51SMario Limonciello
104f1e1ea51SMario Limonciello pr_debug("entry\n");
105f1e1ea51SMario Limonciello
106f1e1ea51SMario Limonciello if (!rbu_data.packetsize) {
107f1e1ea51SMario Limonciello pr_debug("packetsize not specified\n");
108f1e1ea51SMario Limonciello retval = -EINVAL;
109f1e1ea51SMario Limonciello goto out_noalloc;
110f1e1ea51SMario Limonciello }
111f1e1ea51SMario Limonciello
112f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
113f1e1ea51SMario Limonciello
114f1e1ea51SMario Limonciello newpacket = kzalloc(sizeof (struct packet_data), GFP_KERNEL);
115f1e1ea51SMario Limonciello
116f1e1ea51SMario Limonciello if (!newpacket) {
117f1e1ea51SMario Limonciello pr_warn("failed to allocate new packet\n");
118f1e1ea51SMario Limonciello retval = -ENOMEM;
119f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
120f1e1ea51SMario Limonciello goto out_noalloc;
121f1e1ea51SMario Limonciello }
122f1e1ea51SMario Limonciello
123f1e1ea51SMario Limonciello ordernum = get_order(length);
124f1e1ea51SMario Limonciello
125f1e1ea51SMario Limonciello /*
126f1e1ea51SMario Limonciello * BIOS errata mean we cannot allocate packets below 1MB or they will
127f1e1ea51SMario Limonciello * be overwritten by BIOS.
128f1e1ea51SMario Limonciello *
129f1e1ea51SMario Limonciello * array to temporarily hold packets
130f1e1ea51SMario Limonciello * that are below the allocation floor
131f1e1ea51SMario Limonciello *
132f1e1ea51SMario Limonciello * NOTE: very simplistic because we only need the floor to be at 1MB
133f1e1ea51SMario Limonciello * due to BIOS errata. This shouldn't be used for higher floors
134f1e1ea51SMario Limonciello * or you will run out of mem trying to allocate the array.
135f1e1ea51SMario Limonciello */
136f1e1ea51SMario Limonciello packet_array_size = max_t(unsigned int, allocation_floor / rbu_data.packetsize, 1);
137f1e1ea51SMario Limonciello invalid_addr_packet_array = kcalloc(packet_array_size, sizeof(void *),
138f1e1ea51SMario Limonciello GFP_KERNEL);
139f1e1ea51SMario Limonciello
140f1e1ea51SMario Limonciello if (!invalid_addr_packet_array) {
141f1e1ea51SMario Limonciello pr_warn("failed to allocate invalid_addr_packet_array\n");
142f1e1ea51SMario Limonciello retval = -ENOMEM;
143f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
144f1e1ea51SMario Limonciello goto out_alloc_packet;
145f1e1ea51SMario Limonciello }
146f1e1ea51SMario Limonciello
147f1e1ea51SMario Limonciello while (!packet_data_temp_buf) {
148f1e1ea51SMario Limonciello packet_data_temp_buf = (unsigned char *)
149f1e1ea51SMario Limonciello __get_free_pages(GFP_KERNEL, ordernum);
150f1e1ea51SMario Limonciello if (!packet_data_temp_buf) {
151f1e1ea51SMario Limonciello pr_warn("failed to allocate new packet\n");
152f1e1ea51SMario Limonciello retval = -ENOMEM;
153f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
154f1e1ea51SMario Limonciello goto out_alloc_packet_array;
155f1e1ea51SMario Limonciello }
156f1e1ea51SMario Limonciello
157f1e1ea51SMario Limonciello if ((unsigned long)virt_to_phys(packet_data_temp_buf)
158f1e1ea51SMario Limonciello < allocation_floor) {
159f1e1ea51SMario Limonciello pr_debug("packet 0x%lx below floor at 0x%lx\n",
160f1e1ea51SMario Limonciello (unsigned long)virt_to_phys(
161f1e1ea51SMario Limonciello packet_data_temp_buf),
162f1e1ea51SMario Limonciello allocation_floor);
163f1e1ea51SMario Limonciello invalid_addr_packet_array[idx++] = packet_data_temp_buf;
164f1e1ea51SMario Limonciello packet_data_temp_buf = NULL;
165f1e1ea51SMario Limonciello }
166f1e1ea51SMario Limonciello }
167f1e1ea51SMario Limonciello /*
168f1e1ea51SMario Limonciello * set to uncachable or it may never get written back before reboot
169f1e1ea51SMario Limonciello */
170f1e1ea51SMario Limonciello set_memory_uc((unsigned long)packet_data_temp_buf, 1 << ordernum);
171f1e1ea51SMario Limonciello
172f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
173f1e1ea51SMario Limonciello
174f1e1ea51SMario Limonciello newpacket->data = packet_data_temp_buf;
175f1e1ea51SMario Limonciello
176f1e1ea51SMario Limonciello pr_debug("newpacket at physical addr %lx\n",
177f1e1ea51SMario Limonciello (unsigned long)virt_to_phys(newpacket->data));
178f1e1ea51SMario Limonciello
179f1e1ea51SMario Limonciello /* packets may not have fixed size */
180f1e1ea51SMario Limonciello newpacket->length = length;
181f1e1ea51SMario Limonciello newpacket->ordernum = ordernum;
182f1e1ea51SMario Limonciello ++rbu_data.num_packets;
183f1e1ea51SMario Limonciello
184f1e1ea51SMario Limonciello /* initialize the newly created packet headers */
185f1e1ea51SMario Limonciello INIT_LIST_HEAD(&newpacket->list);
186f1e1ea51SMario Limonciello list_add_tail(&newpacket->list, &packet_data_head.list);
187f1e1ea51SMario Limonciello
188f1e1ea51SMario Limonciello memcpy(newpacket->data, data, length);
189f1e1ea51SMario Limonciello
190f1e1ea51SMario Limonciello pr_debug("exit\n");
191f1e1ea51SMario Limonciello
192f1e1ea51SMario Limonciello out_alloc_packet_array:
193f1e1ea51SMario Limonciello /* always free packet array */
194f1e1ea51SMario Limonciello while (idx--) {
195f1e1ea51SMario Limonciello pr_debug("freeing unused packet below floor 0x%lx\n",
196f1e1ea51SMario Limonciello (unsigned long)virt_to_phys(invalid_addr_packet_array[idx]));
197f1e1ea51SMario Limonciello free_pages((unsigned long)invalid_addr_packet_array[idx], ordernum);
198f1e1ea51SMario Limonciello }
199f1e1ea51SMario Limonciello kfree(invalid_addr_packet_array);
200f1e1ea51SMario Limonciello
201f1e1ea51SMario Limonciello out_alloc_packet:
202f1e1ea51SMario Limonciello /* if error, free data */
203f1e1ea51SMario Limonciello if (retval)
204f1e1ea51SMario Limonciello kfree(newpacket);
205f1e1ea51SMario Limonciello
206f1e1ea51SMario Limonciello out_noalloc:
207f1e1ea51SMario Limonciello return retval;
208f1e1ea51SMario Limonciello }
209f1e1ea51SMario Limonciello
packetize_data(const u8 * data,size_t length)210f1e1ea51SMario Limonciello static int packetize_data(const u8 *data, size_t length)
211f1e1ea51SMario Limonciello {
212f1e1ea51SMario Limonciello int rc = 0;
213f1e1ea51SMario Limonciello int done = 0;
214f1e1ea51SMario Limonciello int packet_length;
215f1e1ea51SMario Limonciello u8 *temp;
216f1e1ea51SMario Limonciello u8 *end = (u8 *) data + length;
217f1e1ea51SMario Limonciello pr_debug("data length %zd\n", length);
218f1e1ea51SMario Limonciello if (!rbu_data.packetsize) {
219f1e1ea51SMario Limonciello pr_warn("packetsize not specified\n");
220f1e1ea51SMario Limonciello return -EIO;
221f1e1ea51SMario Limonciello }
222f1e1ea51SMario Limonciello
223f1e1ea51SMario Limonciello temp = (u8 *) data;
224f1e1ea51SMario Limonciello
225f1e1ea51SMario Limonciello /* packetize the hunk */
226f1e1ea51SMario Limonciello while (!done) {
227f1e1ea51SMario Limonciello if ((temp + rbu_data.packetsize) < end)
228f1e1ea51SMario Limonciello packet_length = rbu_data.packetsize;
229f1e1ea51SMario Limonciello else {
230f1e1ea51SMario Limonciello /* this is the last packet */
231f1e1ea51SMario Limonciello packet_length = end - temp;
232f1e1ea51SMario Limonciello done = 1;
233f1e1ea51SMario Limonciello }
234f1e1ea51SMario Limonciello
235f1e1ea51SMario Limonciello if ((rc = create_packet(temp, packet_length)))
236f1e1ea51SMario Limonciello return rc;
237f1e1ea51SMario Limonciello
238f1e1ea51SMario Limonciello pr_debug("%p:%td\n", temp, (end - temp));
239f1e1ea51SMario Limonciello temp += packet_length;
240f1e1ea51SMario Limonciello }
241f1e1ea51SMario Limonciello
242f1e1ea51SMario Limonciello rbu_data.imagesize = length;
243f1e1ea51SMario Limonciello
244f1e1ea51SMario Limonciello return rc;
245f1e1ea51SMario Limonciello }
246f1e1ea51SMario Limonciello
do_packet_read(char * data,struct packet_data * newpacket,int length,int bytes_read,int * list_read_count)247f1e1ea51SMario Limonciello static int do_packet_read(char *data, struct packet_data *newpacket,
248f1e1ea51SMario Limonciello int length, int bytes_read, int *list_read_count)
249f1e1ea51SMario Limonciello {
250f1e1ea51SMario Limonciello void *ptemp_buf;
251f1e1ea51SMario Limonciello int bytes_copied = 0;
252f1e1ea51SMario Limonciello int j = 0;
253f1e1ea51SMario Limonciello
254f1e1ea51SMario Limonciello *list_read_count += newpacket->length;
255f1e1ea51SMario Limonciello
256f1e1ea51SMario Limonciello if (*list_read_count > bytes_read) {
257f1e1ea51SMario Limonciello /* point to the start of unread data */
258f1e1ea51SMario Limonciello j = newpacket->length - (*list_read_count - bytes_read);
259f1e1ea51SMario Limonciello /* point to the offset in the packet buffer */
260f1e1ea51SMario Limonciello ptemp_buf = (u8 *) newpacket->data + j;
261f1e1ea51SMario Limonciello /*
262f1e1ea51SMario Limonciello * check if there is enough room in
263f1e1ea51SMario Limonciello * * the incoming buffer
264f1e1ea51SMario Limonciello */
265f1e1ea51SMario Limonciello if (length > (*list_read_count - bytes_read))
266f1e1ea51SMario Limonciello /*
267f1e1ea51SMario Limonciello * copy what ever is there in this
268f1e1ea51SMario Limonciello * packet and move on
269f1e1ea51SMario Limonciello */
270f1e1ea51SMario Limonciello bytes_copied = (*list_read_count - bytes_read);
271f1e1ea51SMario Limonciello else
272f1e1ea51SMario Limonciello /* copy the remaining */
273f1e1ea51SMario Limonciello bytes_copied = length;
274f1e1ea51SMario Limonciello memcpy(data, ptemp_buf, bytes_copied);
275f1e1ea51SMario Limonciello }
276f1e1ea51SMario Limonciello return bytes_copied;
277f1e1ea51SMario Limonciello }
278f1e1ea51SMario Limonciello
packet_read_list(char * data,size_t * pread_length)279f1e1ea51SMario Limonciello static int packet_read_list(char *data, size_t * pread_length)
280f1e1ea51SMario Limonciello {
281f1e1ea51SMario Limonciello struct packet_data *newpacket;
282f1e1ea51SMario Limonciello int temp_count = 0;
283f1e1ea51SMario Limonciello int bytes_copied = 0;
284f1e1ea51SMario Limonciello int bytes_read = 0;
285f1e1ea51SMario Limonciello int remaining_bytes = 0;
286f1e1ea51SMario Limonciello char *pdest = data;
287f1e1ea51SMario Limonciello
288f1e1ea51SMario Limonciello /* check if we have any packets */
289f1e1ea51SMario Limonciello if (0 == rbu_data.num_packets)
290f1e1ea51SMario Limonciello return -ENOMEM;
291f1e1ea51SMario Limonciello
292f1e1ea51SMario Limonciello remaining_bytes = *pread_length;
293f1e1ea51SMario Limonciello bytes_read = rbu_data.packet_read_count;
294f1e1ea51SMario Limonciello
295f1e1ea51SMario Limonciello list_for_each_entry(newpacket, (&packet_data_head.list)->next, list) {
296f1e1ea51SMario Limonciello bytes_copied = do_packet_read(pdest, newpacket,
297f1e1ea51SMario Limonciello remaining_bytes, bytes_read, &temp_count);
298f1e1ea51SMario Limonciello remaining_bytes -= bytes_copied;
299f1e1ea51SMario Limonciello bytes_read += bytes_copied;
300f1e1ea51SMario Limonciello pdest += bytes_copied;
301f1e1ea51SMario Limonciello /*
302f1e1ea51SMario Limonciello * check if we reached end of buffer before reaching the
303f1e1ea51SMario Limonciello * last packet
304f1e1ea51SMario Limonciello */
305f1e1ea51SMario Limonciello if (remaining_bytes == 0)
306f1e1ea51SMario Limonciello break;
307f1e1ea51SMario Limonciello }
308f1e1ea51SMario Limonciello /*finally set the bytes read */
309f1e1ea51SMario Limonciello *pread_length = bytes_read - rbu_data.packet_read_count;
310f1e1ea51SMario Limonciello rbu_data.packet_read_count = bytes_read;
311f1e1ea51SMario Limonciello return 0;
312f1e1ea51SMario Limonciello }
313f1e1ea51SMario Limonciello
packet_empty_list(void)314f1e1ea51SMario Limonciello static void packet_empty_list(void)
315f1e1ea51SMario Limonciello {
316f1e1ea51SMario Limonciello struct packet_data *newpacket, *tmp;
317f1e1ea51SMario Limonciello
318f1e1ea51SMario Limonciello list_for_each_entry_safe(newpacket, tmp, (&packet_data_head.list)->next, list) {
319f1e1ea51SMario Limonciello list_del(&newpacket->list);
320f1e1ea51SMario Limonciello
321f1e1ea51SMario Limonciello /*
322f1e1ea51SMario Limonciello * zero out the RBU packet memory before freeing
323f1e1ea51SMario Limonciello * to make sure there are no stale RBU packets left in memory
324f1e1ea51SMario Limonciello */
325f1e1ea51SMario Limonciello memset(newpacket->data, 0, rbu_data.packetsize);
326f1e1ea51SMario Limonciello set_memory_wb((unsigned long)newpacket->data,
327f1e1ea51SMario Limonciello 1 << newpacket->ordernum);
328f1e1ea51SMario Limonciello free_pages((unsigned long) newpacket->data,
329f1e1ea51SMario Limonciello newpacket->ordernum);
330f1e1ea51SMario Limonciello kfree(newpacket);
331f1e1ea51SMario Limonciello }
332f1e1ea51SMario Limonciello rbu_data.packet_read_count = 0;
333f1e1ea51SMario Limonciello rbu_data.num_packets = 0;
334f1e1ea51SMario Limonciello rbu_data.imagesize = 0;
335f1e1ea51SMario Limonciello }
336f1e1ea51SMario Limonciello
337f1e1ea51SMario Limonciello /*
338f1e1ea51SMario Limonciello * img_update_free: Frees the buffer allocated for storing BIOS image
339f1e1ea51SMario Limonciello * Always called with lock held and returned with lock held
340f1e1ea51SMario Limonciello */
img_update_free(void)341f1e1ea51SMario Limonciello static void img_update_free(void)
342f1e1ea51SMario Limonciello {
343f1e1ea51SMario Limonciello if (!rbu_data.image_update_buffer)
344f1e1ea51SMario Limonciello return;
345f1e1ea51SMario Limonciello /*
346f1e1ea51SMario Limonciello * zero out this buffer before freeing it to get rid of any stale
347f1e1ea51SMario Limonciello * BIOS image copied in memory.
348f1e1ea51SMario Limonciello */
349f1e1ea51SMario Limonciello memset(rbu_data.image_update_buffer, 0,
350f1e1ea51SMario Limonciello rbu_data.image_update_buffer_size);
351f1e1ea51SMario Limonciello free_pages((unsigned long) rbu_data.image_update_buffer,
352f1e1ea51SMario Limonciello rbu_data.image_update_ordernum);
353f1e1ea51SMario Limonciello
354f1e1ea51SMario Limonciello /*
355f1e1ea51SMario Limonciello * Re-initialize the rbu_data variables after a free
356f1e1ea51SMario Limonciello */
357f1e1ea51SMario Limonciello rbu_data.image_update_ordernum = -1;
358f1e1ea51SMario Limonciello rbu_data.image_update_buffer = NULL;
359f1e1ea51SMario Limonciello rbu_data.image_update_buffer_size = 0;
360f1e1ea51SMario Limonciello rbu_data.bios_image_size = 0;
361f1e1ea51SMario Limonciello }
362f1e1ea51SMario Limonciello
363f1e1ea51SMario Limonciello /*
364f1e1ea51SMario Limonciello * img_update_realloc: This function allocates the contiguous pages to
365f1e1ea51SMario Limonciello * accommodate the requested size of data. The memory address and size
366f1e1ea51SMario Limonciello * values are stored globally and on every call to this function the new
367f1e1ea51SMario Limonciello * size is checked to see if more data is required than the existing size.
368f1e1ea51SMario Limonciello * If true the previous memory is freed and new allocation is done to
369f1e1ea51SMario Limonciello * accommodate the new size. If the incoming size is less then than the
370f1e1ea51SMario Limonciello * already allocated size, then that memory is reused. This function is
371f1e1ea51SMario Limonciello * called with lock held and returns with lock held.
372f1e1ea51SMario Limonciello */
img_update_realloc(unsigned long size)373f1e1ea51SMario Limonciello static int img_update_realloc(unsigned long size)
374f1e1ea51SMario Limonciello {
375f1e1ea51SMario Limonciello unsigned char *image_update_buffer = NULL;
376f1e1ea51SMario Limonciello unsigned long img_buf_phys_addr;
377f1e1ea51SMario Limonciello int ordernum;
378f1e1ea51SMario Limonciello
379f1e1ea51SMario Limonciello /*
380f1e1ea51SMario Limonciello * check if the buffer of sufficient size has been
381f1e1ea51SMario Limonciello * already allocated
382f1e1ea51SMario Limonciello */
383f1e1ea51SMario Limonciello if (rbu_data.image_update_buffer_size >= size) {
384f1e1ea51SMario Limonciello /*
385f1e1ea51SMario Limonciello * check for corruption
386f1e1ea51SMario Limonciello */
387f1e1ea51SMario Limonciello if ((size != 0) && (rbu_data.image_update_buffer == NULL)) {
388f1e1ea51SMario Limonciello pr_err("corruption check failed\n");
389f1e1ea51SMario Limonciello return -EINVAL;
390f1e1ea51SMario Limonciello }
391f1e1ea51SMario Limonciello /*
392f1e1ea51SMario Limonciello * we have a valid pre-allocated buffer with
393f1e1ea51SMario Limonciello * sufficient size
394f1e1ea51SMario Limonciello */
395f1e1ea51SMario Limonciello return 0;
396f1e1ea51SMario Limonciello }
397f1e1ea51SMario Limonciello
398f1e1ea51SMario Limonciello /*
399f1e1ea51SMario Limonciello * free any previously allocated buffer
400f1e1ea51SMario Limonciello */
401f1e1ea51SMario Limonciello img_update_free();
402f1e1ea51SMario Limonciello
403f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
404f1e1ea51SMario Limonciello
405f1e1ea51SMario Limonciello ordernum = get_order(size);
406f1e1ea51SMario Limonciello image_update_buffer =
407f1e1ea51SMario Limonciello (unsigned char *)__get_free_pages(GFP_DMA32, ordernum);
408f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
409f1e1ea51SMario Limonciello if (!image_update_buffer) {
410f1e1ea51SMario Limonciello pr_debug("Not enough memory for image update: size = %ld\n", size);
411f1e1ea51SMario Limonciello return -ENOMEM;
412f1e1ea51SMario Limonciello }
413f1e1ea51SMario Limonciello
414f1e1ea51SMario Limonciello img_buf_phys_addr = (unsigned long)virt_to_phys(image_update_buffer);
415f1e1ea51SMario Limonciello if (WARN_ON_ONCE(img_buf_phys_addr > BIOS_SCAN_LIMIT))
416f1e1ea51SMario Limonciello return -EINVAL; /* can't happen per definition */
417f1e1ea51SMario Limonciello
418f1e1ea51SMario Limonciello rbu_data.image_update_buffer = image_update_buffer;
419f1e1ea51SMario Limonciello rbu_data.image_update_buffer_size = size;
420f1e1ea51SMario Limonciello rbu_data.bios_image_size = rbu_data.image_update_buffer_size;
421f1e1ea51SMario Limonciello rbu_data.image_update_ordernum = ordernum;
422f1e1ea51SMario Limonciello return 0;
423f1e1ea51SMario Limonciello }
424f1e1ea51SMario Limonciello
read_packet_data(char * buffer,loff_t pos,size_t count)425f1e1ea51SMario Limonciello static ssize_t read_packet_data(char *buffer, loff_t pos, size_t count)
426f1e1ea51SMario Limonciello {
427f1e1ea51SMario Limonciello int retval;
428f1e1ea51SMario Limonciello size_t bytes_left;
429f1e1ea51SMario Limonciello size_t data_length;
430f1e1ea51SMario Limonciello char *ptempBuf = buffer;
431f1e1ea51SMario Limonciello
432f1e1ea51SMario Limonciello /* check to see if we have something to return */
433f1e1ea51SMario Limonciello if (rbu_data.num_packets == 0) {
434f1e1ea51SMario Limonciello pr_debug("no packets written\n");
435f1e1ea51SMario Limonciello retval = -ENOMEM;
436f1e1ea51SMario Limonciello goto read_rbu_data_exit;
437f1e1ea51SMario Limonciello }
438f1e1ea51SMario Limonciello
439f1e1ea51SMario Limonciello if (pos > rbu_data.imagesize) {
440f1e1ea51SMario Limonciello retval = 0;
441f1e1ea51SMario Limonciello pr_warn("data underrun\n");
442f1e1ea51SMario Limonciello goto read_rbu_data_exit;
443f1e1ea51SMario Limonciello }
444f1e1ea51SMario Limonciello
445f1e1ea51SMario Limonciello bytes_left = rbu_data.imagesize - pos;
446f1e1ea51SMario Limonciello data_length = min(bytes_left, count);
447f1e1ea51SMario Limonciello
448f1e1ea51SMario Limonciello if ((retval = packet_read_list(ptempBuf, &data_length)) < 0)
449f1e1ea51SMario Limonciello goto read_rbu_data_exit;
450f1e1ea51SMario Limonciello
451f1e1ea51SMario Limonciello if ((pos + count) > rbu_data.imagesize) {
452f1e1ea51SMario Limonciello rbu_data.packet_read_count = 0;
453f1e1ea51SMario Limonciello /* this was the last copy */
454f1e1ea51SMario Limonciello retval = bytes_left;
455f1e1ea51SMario Limonciello } else
456f1e1ea51SMario Limonciello retval = count;
457f1e1ea51SMario Limonciello
458f1e1ea51SMario Limonciello read_rbu_data_exit:
459f1e1ea51SMario Limonciello return retval;
460f1e1ea51SMario Limonciello }
461f1e1ea51SMario Limonciello
read_rbu_mono_data(char * buffer,loff_t pos,size_t count)462f1e1ea51SMario Limonciello static ssize_t read_rbu_mono_data(char *buffer, loff_t pos, size_t count)
463f1e1ea51SMario Limonciello {
464f1e1ea51SMario Limonciello /* check to see if we have something to return */
465f1e1ea51SMario Limonciello if ((rbu_data.image_update_buffer == NULL) ||
466f1e1ea51SMario Limonciello (rbu_data.bios_image_size == 0)) {
467f1e1ea51SMario Limonciello pr_debug("image_update_buffer %p, bios_image_size %lu\n",
468f1e1ea51SMario Limonciello rbu_data.image_update_buffer,
469f1e1ea51SMario Limonciello rbu_data.bios_image_size);
470f1e1ea51SMario Limonciello return -ENOMEM;
471f1e1ea51SMario Limonciello }
472f1e1ea51SMario Limonciello
473f1e1ea51SMario Limonciello return memory_read_from_buffer(buffer, count, &pos,
474f1e1ea51SMario Limonciello rbu_data.image_update_buffer, rbu_data.bios_image_size);
475f1e1ea51SMario Limonciello }
476f1e1ea51SMario Limonciello
data_read(struct file * filp,struct kobject * kobj,struct bin_attribute * bin_attr,char * buffer,loff_t pos,size_t count)477f1e1ea51SMario Limonciello static ssize_t data_read(struct file *filp, struct kobject *kobj,
478f1e1ea51SMario Limonciello struct bin_attribute *bin_attr,
479f1e1ea51SMario Limonciello char *buffer, loff_t pos, size_t count)
480f1e1ea51SMario Limonciello {
481f1e1ea51SMario Limonciello ssize_t ret_count = 0;
482f1e1ea51SMario Limonciello
483f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
484f1e1ea51SMario Limonciello
485f1e1ea51SMario Limonciello if (!strcmp(image_type, "mono"))
486f1e1ea51SMario Limonciello ret_count = read_rbu_mono_data(buffer, pos, count);
487f1e1ea51SMario Limonciello else if (!strcmp(image_type, "packet"))
488f1e1ea51SMario Limonciello ret_count = read_packet_data(buffer, pos, count);
489f1e1ea51SMario Limonciello else
490f1e1ea51SMario Limonciello pr_debug("invalid image type specified\n");
491f1e1ea51SMario Limonciello
492f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
493f1e1ea51SMario Limonciello return ret_count;
494f1e1ea51SMario Limonciello }
495f1e1ea51SMario Limonciello static BIN_ATTR_RO(data, 0);
496f1e1ea51SMario Limonciello
callbackfn_rbu(const struct firmware * fw,void * context)497f1e1ea51SMario Limonciello static void callbackfn_rbu(const struct firmware *fw, void *context)
498f1e1ea51SMario Limonciello {
499f1e1ea51SMario Limonciello rbu_data.entry_created = 0;
500f1e1ea51SMario Limonciello
501f1e1ea51SMario Limonciello if (!fw)
502f1e1ea51SMario Limonciello return;
503f1e1ea51SMario Limonciello
504f1e1ea51SMario Limonciello if (!fw->size)
505f1e1ea51SMario Limonciello goto out;
506f1e1ea51SMario Limonciello
507f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
508f1e1ea51SMario Limonciello if (!strcmp(image_type, "mono")) {
509f1e1ea51SMario Limonciello if (!img_update_realloc(fw->size))
510f1e1ea51SMario Limonciello memcpy(rbu_data.image_update_buffer,
511f1e1ea51SMario Limonciello fw->data, fw->size);
512f1e1ea51SMario Limonciello } else if (!strcmp(image_type, "packet")) {
513f1e1ea51SMario Limonciello /*
514f1e1ea51SMario Limonciello * we need to free previous packets if a
515f1e1ea51SMario Limonciello * new hunk of packets needs to be downloaded
516f1e1ea51SMario Limonciello */
517f1e1ea51SMario Limonciello packet_empty_list();
518f1e1ea51SMario Limonciello if (packetize_data(fw->data, fw->size))
519f1e1ea51SMario Limonciello /* Incase something goes wrong when we are
520f1e1ea51SMario Limonciello * in middle of packetizing the data, we
521f1e1ea51SMario Limonciello * need to free up whatever packets might
522f1e1ea51SMario Limonciello * have been created before we quit.
523f1e1ea51SMario Limonciello */
524f1e1ea51SMario Limonciello packet_empty_list();
525f1e1ea51SMario Limonciello } else
526f1e1ea51SMario Limonciello pr_debug("invalid image type specified\n");
527f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
528f1e1ea51SMario Limonciello out:
529f1e1ea51SMario Limonciello release_firmware(fw);
530f1e1ea51SMario Limonciello }
531f1e1ea51SMario Limonciello
image_type_read(struct file * filp,struct kobject * kobj,struct bin_attribute * bin_attr,char * buffer,loff_t pos,size_t count)532f1e1ea51SMario Limonciello static ssize_t image_type_read(struct file *filp, struct kobject *kobj,
533f1e1ea51SMario Limonciello struct bin_attribute *bin_attr,
534f1e1ea51SMario Limonciello char *buffer, loff_t pos, size_t count)
535f1e1ea51SMario Limonciello {
536f1e1ea51SMario Limonciello int size = 0;
537f1e1ea51SMario Limonciello if (!pos)
538f1e1ea51SMario Limonciello size = scnprintf(buffer, count, "%s\n", image_type);
539f1e1ea51SMario Limonciello return size;
540f1e1ea51SMario Limonciello }
541f1e1ea51SMario Limonciello
image_type_write(struct file * filp,struct kobject * kobj,struct bin_attribute * bin_attr,char * buffer,loff_t pos,size_t count)542f1e1ea51SMario Limonciello static ssize_t image_type_write(struct file *filp, struct kobject *kobj,
543f1e1ea51SMario Limonciello struct bin_attribute *bin_attr,
544f1e1ea51SMario Limonciello char *buffer, loff_t pos, size_t count)
545f1e1ea51SMario Limonciello {
546f1e1ea51SMario Limonciello int rc = count;
547f1e1ea51SMario Limonciello int req_firm_rc = 0;
548f1e1ea51SMario Limonciello int i;
549f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
550f1e1ea51SMario Limonciello /*
551f1e1ea51SMario Limonciello * Find the first newline or space
552f1e1ea51SMario Limonciello */
553f1e1ea51SMario Limonciello for (i = 0; i < count; ++i)
554f1e1ea51SMario Limonciello if (buffer[i] == '\n' || buffer[i] == ' ') {
555f1e1ea51SMario Limonciello buffer[i] = '\0';
556f1e1ea51SMario Limonciello break;
557f1e1ea51SMario Limonciello }
558f1e1ea51SMario Limonciello if (i == count)
559f1e1ea51SMario Limonciello buffer[count] = '\0';
560f1e1ea51SMario Limonciello
561f1e1ea51SMario Limonciello if (strstr(buffer, "mono"))
562f1e1ea51SMario Limonciello strcpy(image_type, "mono");
563f1e1ea51SMario Limonciello else if (strstr(buffer, "packet"))
564f1e1ea51SMario Limonciello strcpy(image_type, "packet");
565f1e1ea51SMario Limonciello else if (strstr(buffer, "init")) {
566f1e1ea51SMario Limonciello /*
567f1e1ea51SMario Limonciello * If due to the user error the driver gets in a bad
568f1e1ea51SMario Limonciello * state where even though it is loaded , the
569f1e1ea51SMario Limonciello * /sys/class/firmware/dell_rbu entries are missing.
570f1e1ea51SMario Limonciello * to cover this situation the user can recreate entries
571f1e1ea51SMario Limonciello * by writing init to image_type.
572f1e1ea51SMario Limonciello */
573f1e1ea51SMario Limonciello if (!rbu_data.entry_created) {
574f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
575f1e1ea51SMario Limonciello req_firm_rc = request_firmware_nowait(THIS_MODULE,
5760733d839SShawn Guo FW_ACTION_NOUEVENT, "dell_rbu",
577f1e1ea51SMario Limonciello &rbu_device->dev, GFP_KERNEL, &context,
578f1e1ea51SMario Limonciello callbackfn_rbu);
579f1e1ea51SMario Limonciello if (req_firm_rc) {
580f1e1ea51SMario Limonciello pr_err("request_firmware_nowait failed %d\n", rc);
581f1e1ea51SMario Limonciello rc = -EIO;
582f1e1ea51SMario Limonciello } else
583f1e1ea51SMario Limonciello rbu_data.entry_created = 1;
584f1e1ea51SMario Limonciello
585f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
586f1e1ea51SMario Limonciello }
587f1e1ea51SMario Limonciello } else {
588f1e1ea51SMario Limonciello pr_warn("image_type is invalid\n");
589f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
590f1e1ea51SMario Limonciello return -EINVAL;
591f1e1ea51SMario Limonciello }
592f1e1ea51SMario Limonciello
593f1e1ea51SMario Limonciello /* we must free all previous allocations */
594f1e1ea51SMario Limonciello packet_empty_list();
595f1e1ea51SMario Limonciello img_update_free();
596f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
597f1e1ea51SMario Limonciello
598f1e1ea51SMario Limonciello return rc;
599f1e1ea51SMario Limonciello }
600f1e1ea51SMario Limonciello static BIN_ATTR_RW(image_type, 0);
601f1e1ea51SMario Limonciello
packet_size_read(struct file * filp,struct kobject * kobj,struct bin_attribute * bin_attr,char * buffer,loff_t pos,size_t count)602f1e1ea51SMario Limonciello static ssize_t packet_size_read(struct file *filp, struct kobject *kobj,
603f1e1ea51SMario Limonciello struct bin_attribute *bin_attr,
604f1e1ea51SMario Limonciello char *buffer, loff_t pos, size_t count)
605f1e1ea51SMario Limonciello {
606f1e1ea51SMario Limonciello int size = 0;
607f1e1ea51SMario Limonciello if (!pos) {
608f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
609f1e1ea51SMario Limonciello size = scnprintf(buffer, count, "%lu\n", rbu_data.packetsize);
610f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
611f1e1ea51SMario Limonciello }
612f1e1ea51SMario Limonciello return size;
613f1e1ea51SMario Limonciello }
614f1e1ea51SMario Limonciello
packet_size_write(struct file * filp,struct kobject * kobj,struct bin_attribute * bin_attr,char * buffer,loff_t pos,size_t count)615f1e1ea51SMario Limonciello static ssize_t packet_size_write(struct file *filp, struct kobject *kobj,
616f1e1ea51SMario Limonciello struct bin_attribute *bin_attr,
617f1e1ea51SMario Limonciello char *buffer, loff_t pos, size_t count)
618f1e1ea51SMario Limonciello {
619f1e1ea51SMario Limonciello unsigned long temp;
620f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
621f1e1ea51SMario Limonciello packet_empty_list();
622f1e1ea51SMario Limonciello sscanf(buffer, "%lu", &temp);
623f1e1ea51SMario Limonciello if (temp < 0xffffffff)
624f1e1ea51SMario Limonciello rbu_data.packetsize = temp;
625f1e1ea51SMario Limonciello
626f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
627f1e1ea51SMario Limonciello return count;
628f1e1ea51SMario Limonciello }
629f1e1ea51SMario Limonciello static BIN_ATTR_RW(packet_size, 0);
630f1e1ea51SMario Limonciello
631f1e1ea51SMario Limonciello static struct bin_attribute *rbu_bin_attrs[] = {
632f1e1ea51SMario Limonciello &bin_attr_data,
633f1e1ea51SMario Limonciello &bin_attr_image_type,
634f1e1ea51SMario Limonciello &bin_attr_packet_size,
635f1e1ea51SMario Limonciello NULL
636f1e1ea51SMario Limonciello };
637f1e1ea51SMario Limonciello
638f1e1ea51SMario Limonciello static const struct attribute_group rbu_group = {
639f1e1ea51SMario Limonciello .bin_attrs = rbu_bin_attrs,
640f1e1ea51SMario Limonciello };
641f1e1ea51SMario Limonciello
dcdrbu_init(void)642f1e1ea51SMario Limonciello static int __init dcdrbu_init(void)
643f1e1ea51SMario Limonciello {
644f1e1ea51SMario Limonciello int rc;
645f1e1ea51SMario Limonciello spin_lock_init(&rbu_data.lock);
646f1e1ea51SMario Limonciello
647f1e1ea51SMario Limonciello init_packet_head();
648*8d05fc03SBarnabás Pőcze rbu_device = platform_device_register_simple("dell_rbu", PLATFORM_DEVID_NONE, NULL, 0);
649f1e1ea51SMario Limonciello if (IS_ERR(rbu_device)) {
650f1e1ea51SMario Limonciello pr_err("platform_device_register_simple failed\n");
651f1e1ea51SMario Limonciello return PTR_ERR(rbu_device);
652f1e1ea51SMario Limonciello }
653f1e1ea51SMario Limonciello
654f1e1ea51SMario Limonciello rc = sysfs_create_group(&rbu_device->dev.kobj, &rbu_group);
655f1e1ea51SMario Limonciello if (rc)
656f1e1ea51SMario Limonciello goto out_devreg;
657f1e1ea51SMario Limonciello
658f1e1ea51SMario Limonciello rbu_data.entry_created = 0;
659f1e1ea51SMario Limonciello return 0;
660f1e1ea51SMario Limonciello
661f1e1ea51SMario Limonciello out_devreg:
662f1e1ea51SMario Limonciello platform_device_unregister(rbu_device);
663f1e1ea51SMario Limonciello return rc;
664f1e1ea51SMario Limonciello }
665f1e1ea51SMario Limonciello
dcdrbu_exit(void)666f1e1ea51SMario Limonciello static __exit void dcdrbu_exit(void)
667f1e1ea51SMario Limonciello {
668f1e1ea51SMario Limonciello spin_lock(&rbu_data.lock);
669f1e1ea51SMario Limonciello packet_empty_list();
670f1e1ea51SMario Limonciello img_update_free();
671f1e1ea51SMario Limonciello spin_unlock(&rbu_data.lock);
672f1e1ea51SMario Limonciello sysfs_remove_group(&rbu_device->dev.kobj, &rbu_group);
673f1e1ea51SMario Limonciello platform_device_unregister(rbu_device);
674f1e1ea51SMario Limonciello }
675f1e1ea51SMario Limonciello
676f1e1ea51SMario Limonciello module_exit(dcdrbu_exit);
677f1e1ea51SMario Limonciello module_init(dcdrbu_init);
678