cregit-Linux how code gets into the kernel

Release 4.14 arch/powerpc/platforms/powermac/nvram.c

/*
 *  Copyright (C) 2002 Benjamin Herrenschmidt (benh@kernel.crashing.org)
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version
 *  2 of the License, or (at your option) any later version.
 *
 *  Todo: - add support for the OF persistent properties
 */
#include <linux/export.h>
#include <linux/kernel.h>
#include <linux/stddef.h>
#include <linux/string.h>
#include <linux/nvram.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/errno.h>
#include <linux/adb.h>
#include <linux/pmu.h>
#include <linux/bootmem.h>
#include <linux/completion.h>
#include <linux/spinlock.h>
#include <asm/sections.h>
#include <asm/io.h>
#include <asm/prom.h>
#include <asm/machdep.h>
#include <asm/nvram.h>

#include "pmac.h"


#define DEBUG

#ifdef DEBUG

#define DBG(x...) printk(x)
#else

#define DBG(x...)
#endif


#define NVRAM_SIZE		0x2000	
/* 8kB of non-volatile RAM */


#define CORE99_SIGNATURE	0x5a

#define CORE99_ADLER_START	0x14

/* On Core99, nvram is either a sharp, a micron or an AMD flash */

#define SM_FLASH_STATUS_DONE	0x80

#define SM_FLASH_STATUS_ERR	0x38


#define SM_FLASH_CMD_ERASE_CONFIRM	0xd0

#define SM_FLASH_CMD_ERASE_SETUP	0x20

#define SM_FLASH_CMD_RESET		0xff

#define SM_FLASH_CMD_WRITE_SETUP	0x40

#define SM_FLASH_CMD_CLEAR_STATUS	0x50

#define SM_FLASH_CMD_READ_STATUS	0x70

/* CHRP NVRAM header */

struct chrp_header {
  
u8		signature;
  
u8		cksum;
  
u16		len;
  
char          name[12];
  
u8		data[0];
};


struct core99_header {
  
struct chrp_header	hdr;
  
u32			adler;
  
u32			generation;
  
u32			reserved[2];
};

/*
 * Read and write the non-volatile RAM on PowerMacs and CHRP machines.
 */

static int nvram_naddrs;

static volatile unsigned char __iomem *nvram_data;

static int is_core_99;

static int core99_bank = 0;

static int nvram_partitions[3];
// XXX Turn that into a sem
static DEFINE_RAW_SPINLOCK(nv_lock);


static int (*core99_write_bank)(int bank, u8* datas);

static int (*core99_erase_bank)(int bank);


static char *nvram_image;



static unsigned char core99_nvram_read_byte(int addr) { if (nvram_image == NULL) return 0xff; return nvram_image[addr]; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras25100.00%1100.00%
Total25100.00%1100.00%


static void core99_nvram_write_byte(int addr, unsigned char val) { if (nvram_image == NULL) return; nvram_image[addr] = val; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras27100.00%1100.00%
Total27100.00%1100.00%


static ssize_t core99_nvram_read(char *buf, size_t count, loff_t *index) { int i; if (nvram_image == NULL) return -ENODEV; if (*index > NVRAM_SIZE) return 0; i = *index; if (i + count > NVRAM_SIZE) count = NVRAM_SIZE - i; memcpy(buf, &nvram_image[i], count); *index = i + count; return count; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras82100.00%1100.00%
Total82100.00%1100.00%


static ssize_t core99_nvram_write(char *buf, size_t count, loff_t *index) { int i; if (nvram_image == NULL) return -ENODEV; if (*index > NVRAM_SIZE) return 0; i = *index; if (i + count > NVRAM_SIZE) count = NVRAM_SIZE - i; memcpy(&nvram_image[i], buf, count); *index = i + count; return count; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras82100.00%1100.00%
Total82100.00%1100.00%


static ssize_t core99_nvram_size(void) { if (nvram_image == NULL) return -ENODEV; return NVRAM_SIZE; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras21100.00%1100.00%
Total21100.00%1100.00%

#ifdef CONFIG_PPC32 static volatile unsigned char __iomem *nvram_addr; static int nvram_mult;
static unsigned char direct_nvram_read_byte(int addr) { return in_8(&nvram_data[(addr & (NVRAM_SIZE - 1)) * nvram_mult]); }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras30100.00%1100.00%
Total30100.00%1100.00%


static void direct_nvram_write_byte(int addr, unsigned char val) { out_8(&nvram_data[(addr & (NVRAM_SIZE - 1)) * nvram_mult], val); }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras34100.00%1100.00%
Total34100.00%1100.00%


static unsigned char indirect_nvram_read_byte(int addr) { unsigned char val; unsigned long flags; raw_spin_lock_irqsave(&nv_lock, flags); out_8(nvram_addr, addr >> 5); val = in_8(&nvram_data[(addr & 0x1f) << 4]); raw_spin_unlock_irqrestore(&nv_lock, flags); return val; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras6196.83%150.00%
Thomas Gleixner23.17%150.00%
Total63100.00%2100.00%


static void indirect_nvram_write_byte(int addr, unsigned char val) { unsigned long flags; raw_spin_lock_irqsave(&nv_lock, flags); out_8(nvram_addr, addr >> 5); out_8(&nvram_data[(addr & 0x1f) << 4], val); raw_spin_unlock_irqrestore(&nv_lock, flags); }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras5796.61%150.00%
Thomas Gleixner23.39%150.00%
Total59100.00%2100.00%

#ifdef CONFIG_ADB_PMU
static void pmu_nvram_complete(struct adb_request *req) { if (req->arg) complete((struct completion *)req->arg); }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras29100.00%1100.00%
Total29100.00%1100.00%


static unsigned char pmu_nvram_read_byte(int addr) { struct adb_request req; DECLARE_COMPLETION_ONSTACK(req_complete); req.arg = system_state == SYSTEM_RUNNING ? &req_complete : NULL; if (pmu_request(&req, pmu_nvram_complete, 3, PMU_READ_NVRAM, (addr >> 8) & 0xff, addr & 0xff)) return 0xff; if (system_state == SYSTEM_RUNNING) wait_for_completion(&req_complete); while (!req.complete) pmu_poll(); return req.reply[0]; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras9098.90%150.00%
Peter Zijlstra11.10%150.00%
Total91100.00%2100.00%


static void pmu_nvram_write_byte(int addr, unsigned char val) { struct adb_request req; DECLARE_COMPLETION_ONSTACK(req_complete); req.arg = system_state == SYSTEM_RUNNING ? &req_complete : NULL; if (pmu_request(&req, pmu_nvram_complete, 4, PMU_WRITE_NVRAM, (addr >> 8) & 0xff, addr & 0xff, val)) return; if (system_state == SYSTEM_RUNNING) wait_for_completion(&req_complete); while (!req.complete) pmu_poll(); }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras8598.84%150.00%
Peter Zijlstra11.16%150.00%
Total86100.00%2100.00%

#endif /* CONFIG_ADB_PMU */ #endif /* CONFIG_PPC32 */
static u8 chrp_checksum(struct chrp_header* hdr) { u8 *ptr; u16 sum = hdr->signature; for (ptr = (u8 *)&hdr->len; ptr < hdr->data; ptr++) sum += *ptr; while (sum > 0xFF) sum = (sum & 0xFF) + (sum>>8); return sum; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras72100.00%1100.00%
Total72100.00%1100.00%


static u32 core99_calc_adler(u8 *buffer) { int cnt; u32 low, high; buffer += CORE99_ADLER_START; low = 1; high = 0; for (cnt=0; cnt<(NVRAM_SIZE-CORE99_ADLER_START); cnt++) { if ((cnt % 5000) == 0) { high %= 65521UL; high %= 65521UL; } low += buffer[cnt]; high += low; } low %= 65521UL; high %= 65521UL; return (high << 16) | low; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras97100.00%1100.00%
Total97100.00%1100.00%


static u32 core99_check(u8* datas) { struct core99_header* hdr99 = (struct core99_header*)datas; if (hdr99->hdr.signature != CORE99_SIGNATURE) { DBG("Invalid signature\n"); return 0; } if (hdr99->hdr.cksum != chrp_checksum(&hdr99->hdr)) { DBG("Invalid checksum\n"); return 0; } if (hdr99->adler != core99_calc_adler(datas)) { DBG("Invalid adler\n"); return 0; } return hdr99->generation; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras94100.00%1100.00%
Total94100.00%1100.00%


static int sm_erase_bank(int bank) { int stat; unsigned long timeout; u8 __iomem *base = (u8 __iomem *)nvram_data + core99_bank*NVRAM_SIZE; DBG("nvram: Sharp/Micron Erasing bank %d...\n", bank); out_8(base, SM_FLASH_CMD_ERASE_SETUP); out_8(base, SM_FLASH_CMD_ERASE_CONFIRM); timeout = 0; do { if (++timeout > 1000000) { printk(KERN_ERR "nvram: Sharp/Micron flash erase timeout !\n"); break; } out_8(base, SM_FLASH_CMD_READ_STATUS); stat = in_8(base); } while (!(stat & SM_FLASH_STATUS_DONE)); out_8(base, SM_FLASH_CMD_CLEAR_STATUS); out_8(base, SM_FLASH_CMD_RESET); if (memchr_inv(base, 0xff, NVRAM_SIZE)) { printk(KERN_ERR "nvram: Sharp/Micron flash erase failed !\n"); return -ENXIO; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras13294.29%250.00%
Akinobu Mita64.29%125.00%
Stephen Rothwell21.43%125.00%
Total140100.00%4100.00%


static int sm_write_bank(int bank, u8* datas) { int i, stat = 0; unsigned long timeout; u8 __iomem *base = (u8 __iomem *)nvram_data + core99_bank*NVRAM_SIZE; DBG("nvram: Sharp/Micron Writing bank %d...\n", bank); for (i=0; i<NVRAM_SIZE; i++) { out_8(base+i, SM_FLASH_CMD_WRITE_SETUP); udelay(1); out_8(base+i, datas[i]); timeout = 0; do { if (++timeout > 1000000) { printk(KERN_ERR "nvram: Sharp/Micron flash write timeout !\n"); break; } out_8(base, SM_FLASH_CMD_READ_STATUS); stat = in_8(base); } while (!(stat & SM_FLASH_STATUS_DONE)); if (!(stat & SM_FLASH_STATUS_DONE)) break; } out_8(base, SM_FLASH_CMD_CLEAR_STATUS); out_8(base, SM_FLASH_CMD_RESET); if (memcmp(base, datas, NVRAM_SIZE)) { printk(KERN_ERR "nvram: Sharp/Micron flash write failed !\n"); return -ENXIO; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras17795.68%133.33%
Akinobu Mita63.24%133.33%
Stephen Rothwell21.08%133.33%
Total185100.00%3100.00%


static int amd_erase_bank(int bank) { int stat = 0; unsigned long timeout; u8 __iomem *base = (u8 __iomem *)nvram_data + core99_bank*NVRAM_SIZE; DBG("nvram: AMD Erasing bank %d...\n", bank); /* Unlock 1 */ out_8(base+0x555, 0xaa); udelay(1); /* Unlock 2 */ out_8(base+0x2aa, 0x55); udelay(1); /* Sector-Erase */ out_8(base+0x555, 0x80); udelay(1); out_8(base+0x555, 0xaa); udelay(1); out_8(base+0x2aa, 0x55); udelay(1); out_8(base, 0x30); udelay(1); timeout = 0; do { if (++timeout > 1000000) { printk(KERN_ERR "nvram: AMD flash erase timeout !\n"); break; } stat = in_8(base) ^ in_8(base); } while (stat != 0); /* Reset */ out_8(base, 0xf0); udelay(1); if (memchr_inv(base, 0xff, NVRAM_SIZE)) { printk(KERN_ERR "nvram: AMD flash erase failed !\n"); return -ENXIO; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras19996.14%133.33%
Akinobu Mita62.90%133.33%
Stephen Rothwell20.97%133.33%
Total207100.00%3100.00%


static int amd_write_bank(int bank, u8* datas) { int i, stat = 0; unsigned long timeout; u8 __iomem *base = (u8 __iomem *)nvram_data + core99_bank*NVRAM_SIZE; DBG("nvram: AMD Writing bank %d...\n", bank); for (i=0; i<NVRAM_SIZE; i++) { /* Unlock 1 */ out_8(base+0x555, 0xaa); udelay(1); /* Unlock 2 */ out_8(base+0x2aa, 0x55); udelay(1); /* Write single word */ out_8(base+0x555, 0xa0); udelay(1); out_8(base+i, datas[i]); timeout = 0; do { if (++timeout > 1000000) { printk(KERN_ERR "nvram: AMD flash write timeout !\n"); break; } stat = in_8(base) ^ in_8(base); } while (stat != 0); if (stat != 0) break; } /* Reset */ out_8(base, 0xf0); udelay(1); if (memcmp(base, datas, NVRAM_SIZE)) { printk(KERN_ERR "nvram: AMD flash write failed !\n"); return -ENXIO; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras19996.14%133.33%
Akinobu Mita62.90%133.33%
Stephen Rothwell20.97%133.33%
Total207100.00%3100.00%


static void __init lookup_partitions(void) { u8 buffer[17]; int i, offset; struct chrp_header* hdr; if (pmac_newworld) { nvram_partitions[pmac_nvram_OF] = -1; nvram_partitions[pmac_nvram_XPRAM] = -1; nvram_partitions[pmac_nvram_NR] = -1; hdr = (struct chrp_header *)buffer; offset = 0; buffer[16] = 0; do { for (i=0;i<16;i++) buffer[i] = ppc_md.nvram_read_val(offset+i); if (!strcmp(hdr->name, "common")) nvram_partitions[pmac_nvram_OF] = offset + 0x10; if (!strcmp(hdr->name, "APL,MacOS75")) { nvram_partitions[pmac_nvram_XPRAM] = offset + 0x10; nvram_partitions[pmac_nvram_NR] = offset + 0x110; } offset += (hdr->len * 0x10); } while(offset < NVRAM_SIZE); } else { nvram_partitions[pmac_nvram_OF] = 0x1800; nvram_partitions[pmac_nvram_XPRAM] = 0x1300; nvram_partitions[pmac_nvram_NR] = 0x1400; } DBG("nvram: OF partition at 0x%x\n", nvram_partitions[pmac_nvram_OF]); DBG("nvram: XP partition at 0x%x\n", nvram_partitions[pmac_nvram_XPRAM]); DBG("nvram: NR partition at 0x%x\n", nvram_partitions[pmac_nvram_NR]); }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras229100.00%2100.00%
Total229100.00%2100.00%


static void core99_nvram_sync(void) { struct core99_header* hdr99; unsigned long flags; if (!is_core_99 || !nvram_data || !nvram_image) return; raw_spin_lock_irqsave(&nv_lock, flags); if (!memcmp(nvram_image, (u8*)nvram_data + core99_bank*NVRAM_SIZE, NVRAM_SIZE)) goto bail; DBG("Updating nvram...\n"); hdr99 = (struct core99_header*)nvram_image; hdr99->generation++; hdr99->hdr.signature = CORE99_SIGNATURE; hdr99->hdr.cksum = chrp_checksum(&hdr99->hdr); hdr99->adler = core99_calc_adler(nvram_image); core99_bank = core99_bank ? 0 : 1; if (core99_erase_bank) if (core99_erase_bank(core99_bank)) { printk("nvram: Error erasing bank %d\n", core99_bank); goto bail; } if (core99_write_bank) if (core99_write_bank(core99_bank, nvram_image)) printk("nvram: Error writing bank %d\n", core99_bank); bail: raw_spin_unlock_irqrestore(&nv_lock, flags); #ifdef DEBUG mdelay(2000); #endif }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras17998.90%150.00%
Thomas Gleixner21.10%150.00%
Total181100.00%2100.00%


static int __init core99_nvram_setup(struct device_node *dp, unsigned long addr) { int i; u32 gen_bank0, gen_bank1; if (nvram_naddrs < 1) { printk(KERN_ERR "nvram: no address\n"); return -EINVAL; } nvram_image = memblock_virt_alloc(NVRAM_SIZE, 0); nvram_data = ioremap(addr, NVRAM_SIZE*2); nvram_naddrs = 1; /* Make sure we get the correct case */ DBG("nvram: Checking bank 0...\n"); gen_bank0 = core99_check((u8 *)nvram_data); gen_bank1 = core99_check((u8 *)nvram_data + NVRAM_SIZE); core99_bank = (gen_bank0 < gen_bank1) ? 1 : 0; DBG("nvram: gen0=%d, gen1=%d\n", gen_bank0, gen_bank1); DBG("nvram: Active bank is: %d\n", core99_bank); for (i=0; i<NVRAM_SIZE; i++) nvram_image[i] = nvram_data[i + core99_bank*NVRAM_SIZE]; ppc_md.nvram_read_val = core99_nvram_read_byte; ppc_md.nvram_write_val = core99_nvram_write_byte; ppc_md.nvram_read = core99_nvram_read; ppc_md.nvram_write = core99_nvram_write; ppc_md.nvram_size = core99_nvram_size; ppc_md.nvram_sync = core99_nvram_sync; ppc_md.machine_shutdown = core99_nvram_sync; /* * Maybe we could be smarter here though making an exclusive list * of known flash chips is a bit nasty as older OF didn't provide us * with a useful "compatible" entry. A solution would be to really * identify the chip using flash id commands and base ourselves on * a list of known chips IDs */ if (of_device_is_compatible(dp, "amd-0137")) { core99_erase_bank = amd_erase_bank; core99_write_bank = amd_write_bank; } else { core99_erase_bank = sm_erase_bank; core99_write_bank = sm_write_bank; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras21293.39%233.33%
Michael Ellerman93.96%233.33%
Benjamin Herrenschmidt52.20%116.67%
Stephen Rothwell10.44%116.67%
Total227100.00%6100.00%


int __init pmac_nvram_init(void) { struct device_node *dp; struct resource r1, r2; unsigned int s1 = 0, s2 = 0; int err = 0; nvram_naddrs = 0; dp = of_find_node_by_name(NULL, "nvram"); if (dp == NULL) { printk(KERN_ERR "Can't find NVRAM device\n"); return -ENODEV; } /* Try to obtain an address */ if (of_address_to_resource(dp, 0, &r1) == 0) { nvram_naddrs = 1; s1 = resource_size(&r1); if (of_address_to_resource(dp, 1, &r2) == 0) { nvram_naddrs = 2; s2 = resource_size(&r2); } } is_core_99 = of_device_is_compatible(dp, "nvram,flash"); if (is_core_99) { err = core99_nvram_setup(dp, r1.start); goto bail; } #ifdef CONFIG_PPC32 if (machine_is(chrp) && nvram_naddrs == 1) { nvram_data = ioremap(r1.start, s1); nvram_mult = 1; ppc_md.nvram_read_val = direct_nvram_read_byte; ppc_md.nvram_write_val = direct_nvram_write_byte; } else if (nvram_naddrs == 1) { nvram_data = ioremap(r1.start, s1); nvram_mult = (s1 + NVRAM_SIZE - 1) / NVRAM_SIZE; ppc_md.nvram_read_val = direct_nvram_read_byte; ppc_md.nvram_write_val = direct_nvram_write_byte; } else if (nvram_naddrs == 2) { nvram_addr = ioremap(r1.start, s1); nvram_data = ioremap(r2.start, s2); ppc_md.nvram_read_val = indirect_nvram_read_byte; ppc_md.nvram_write_val = indirect_nvram_write_byte; } else if (nvram_naddrs == 0 && sys_ctrler == SYS_CTRLER_PMU) { #ifdef CONFIG_ADB_PMU nvram_naddrs = -1; ppc_md.nvram_read_val = pmu_nvram_read_byte; ppc_md.nvram_write_val = pmu_nvram_write_byte; #endif /* CONFIG_ADB_PMU */ } else { printk(KERN_ERR "Incompatible type of NVRAM\n"); err = -ENXIO; } #endif /* CONFIG_PPC32 */ bail: of_node_put(dp); if (err == 0) lookup_partitions(); return err; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras23566.57%233.33%
Benjamin Herrenschmidt10930.88%233.33%
Joe Perches82.27%116.67%
Stephen Rothwell10.28%116.67%
Total353100.00%6100.00%


int pmac_get_partition(int partition) { return nvram_partitions[partition]; }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras14100.00%1100.00%
Total14100.00%1100.00%


u8 pmac_xpram_read(int xpaddr) { int offset = pmac_get_partition(pmac_nvram_XPRAM); if (offset < 0 || xpaddr < 0 || xpaddr > 0x100) return 0xff; return ppc_md.nvram_read_val(xpaddr + offset); }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras43100.00%2100.00%
Total43100.00%2100.00%


void pmac_xpram_write(int xpaddr, u8 data) { int offset = pmac_get_partition(pmac_nvram_XPRAM); if (offset < 0 || xpaddr < 0 || xpaddr > 0x100) return; ppc_md.nvram_write_val(xpaddr + offset, data); }

Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras45100.00%2100.00%
Total45100.00%2100.00%

EXPORT_SYMBOL(pmac_get_partition); EXPORT_SYMBOL(pmac_xpram_read); EXPORT_SYMBOL(pmac_xpram_write);

Overall Contributors

PersonTokensPropCommitsCommitProp
Paul Mackerras282693.98%213.33%
Benjamin Herrenschmidt1173.89%320.00%
Akinobu Mita240.80%16.67%
Stephen Rothwell120.40%213.33%
Michael Ellerman90.30%213.33%
Joe Perches80.27%16.67%
Thomas Gleixner70.23%16.67%
Peter Zijlstra20.07%16.67%
Jon Mason10.03%16.67%
Paul Gortmaker10.03%16.67%
Total3007100.00%15100.00%
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.