1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice unmodified, this list of conditions, and the following
12 *    disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD$");
32
33#include "opt_ar71xx.h"
34
35#include <sys/param.h>
36#include <sys/systm.h>
37
38#include <sys/bus.h>
39#include <sys/interrupt.h>
40#include <sys/malloc.h>
41#include <sys/kernel.h>
42#include <sys/module.h>
43#include <sys/rman.h>
44#include <sys/lock.h>
45#include <sys/mutex.h>
46
47#include <vm/vm.h>
48#include <vm/pmap.h>
49#include <vm/vm_extern.h>
50
51#include <machine/bus.h>
52#include <machine/cpu.h>
53#include <machine/intr_machdep.h>
54
55#include <dev/pci/pcivar.h>
56#include <dev/pci/pcireg.h>
57
58#include <dev/pci/pcib_private.h>
59#include "pcib_if.h"
60
61#include <mips/atheros/ar71xxreg.h>
62#include <mips/atheros/ar71xx_pci_bus_space.h>
63
64#include <mips/atheros/ar71xx_cpudef.h>
65
66#include <sys/linker.h>
67#include <sys/firmware.h>
68
69#include <mips/atheros/ar71xx_fixup.h>
70
71/*
72 * Take a copy of the EEPROM contents and squirrel it away in a firmware.
73 * The SPI flash will eventually cease to be memory-mapped, so we need
74 * to take a copy of this before the SPI driver initialises.
75 */
76void
77ar71xx_pci_slot_create_eeprom_firmware(device_t dev, u_int bus, u_int slot,
78    u_int func, long int flash_addr, int size)
79{
80	char buf[64];
81	uint16_t *cal_data = (uint16_t *) MIPS_PHYS_TO_KSEG1(flash_addr);
82	void *eeprom = NULL;
83	const struct firmware *fw = NULL;
84
85	device_printf(dev, "EEPROM firmware: 0x%lx @ %d bytes\n",
86	    flash_addr, size);
87
88	eeprom = malloc(size, M_DEVBUF, M_WAITOK | M_ZERO);
89	if (! eeprom) {
90		device_printf(dev,
91			    "%s: malloc failed for '%s', aborting EEPROM\n",
92			    __func__, buf);
93			return;
94	}
95
96	memcpy(eeprom, cal_data, size);
97
98	/*
99	 * Generate a flash EEPROM 'firmware' from the given memory
100	 * region.  Since the SPI controller will eventually
101	 * go into port-IO mode instead of memory-mapped IO
102	 * mode, a copy of the EEPROM contents is required.
103	 */
104	snprintf(buf, sizeof(buf), "%s.%d.bus.%d.%d.%d.eeprom_firmware",
105	    device_get_name(dev), device_get_unit(dev), bus, slot, func);
106	fw = firmware_register(buf, eeprom, size, 1, NULL);
107	if (fw == NULL) {
108		device_printf(dev, "%s: firmware_register (%s) failed\n",
109		    __func__, buf);
110		free(eeprom, M_DEVBUF);
111		return;
112	}
113	device_printf(dev, "device EEPROM '%s' registered\n", buf);
114}
115