linux-imx

// SPDX-License-Identifier: GPL-2.0-or-later

/*

 * LPDDR2-NVM MTD driver. This module provides read, write, erase, lock/unlock

 * support for LPDDR2-NVM PCM memories

 *

 * Copyright © 2012 Micron Technology, Inc.

 *

 * Vincenzo Aliberti <vincenzo.aliberti@gmail.com>

 * Domenico Manna <domenico.manna@gmail.com>

 * Many thanks to Andrea Vigilante for initial enabling

 */

​

#define pr_fmt(fmt) KBUILD_MODNAME ": %s: " fmt, __func__

​

#include <linux/init.h>

#include <linux/io.h>

#include <linux/module.h>

#include <linux/kernel.h>

#include <linux/mtd/map.h>

#include <linux/mtd/mtd.h>

#include <linux/mtd/partitions.h>

#include <linux/slab.h>

#include <linux/platform_device.h>

#include <linux/ioport.h>

#include <linux/err.h>

​

/* Parameters */

#define ERASE_BLOCKSIZE         (0x00020000/2)  /* in Word */

#define WRITE_BUFFSIZE          (0x00000400/2)  /* in Word */

#define OW_BASE_ADDRESS         0x00000000  /* OW offset */

#define BUS_WIDTH           0x00000020  /* x32 devices */

​

/* PFOW symbols address offset */

#define PFOW_QUERY_STRING_P     (0x0000/2)  /* in Word */

#define PFOW_QUERY_STRING_F     (0x0002/2)  /* in Word */

#define PFOW_QUERY_STRING_O     (0x0004/2)  /* in Word */

#define PFOW_QUERY_STRING_W     (0x0006/2)  /* in Word */

​

/* OW registers address */

#define CMD_CODE_OFS            (0x0080/2)  /* in Word */

#define CMD_DATA_OFS            (0x0084/2)  /* in Word */

#define CMD_ADD_L_OFS           (0x0088/2)  /* in Word */

#define CMD_ADD_H_OFS           (0x008A/2)  /* in Word */

#define MPR_L_OFS           (0x0090/2)  /* in Word */

#define MPR_H_OFS           (0x0092/2)  /* in Word */

#define CMD_EXEC_OFS            (0x00C0/2)  /* in Word */

#define STATUS_REG_OFS          (0x00CC/2)  /* in Word */

#define PRG_BUFFER_OFS          (0x0010/2)  /* in Word */

​

/* Datamask */

#define MR_CFGMASK          0x8000

#define SR_OK_DATAMASK          0x0080

​

/* LPDDR2-NVM Commands */

#define LPDDR2_NVM_LOCK         0x0061

#define LPDDR2_NVM_UNLOCK       0x0062

#define LPDDR2_NVM_SW_PROGRAM       0x0041

#define LPDDR2_NVM_SW_OVERWRITE     0x0042

#define LPDDR2_NVM_BUF_PROGRAM      0x00E9

#define LPDDR2_NVM_BUF_OVERWRITE    0x00EA

#define LPDDR2_NVM_ERASE        0x0020

​

/* LPDDR2-NVM Registers offset */

#define LPDDR2_MODE_REG_DATA        0x0040

#define LPDDR2_MODE_REG_CFG     0x0050

​

/*

 * Internal Type Definitions

 * pcm_int_data contains memory controller details:

 * @reg_data : LPDDR2_MODE_REG_DATA register address after remapping

 * @reg_cfg  : LPDDR2_MODE_REG_CFG register address after remapping

 * &bus_width: memory bus-width (eg: x16 2 Bytes, x32 4 Bytes)

 */

struct pcm_int_data {

    void __iomem *ctl_regs;

    int bus_width;

};

​

static DEFINE_MUTEX(lpdd2_nvm_mutex);

​

/*

 * Build a map_word starting from an u_long

 */

static inline map_word build_map_word(u_long myword)

{

    map_word val = { {0} };

    val.x[0] = myword;

    return val;

}

​

/*

 * Build Mode Register Configuration DataMask based on device bus-width