xref: /src/sys/dev/nand/nand_samsung.c

/*	$NetBSD: nand_samsung.c,v 1.1 2012/10/30 22:03:00 ahoka Exp $	*/

/*-
 * Copyright (c) 2012 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Adam Hoka.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Device specific functions for legacy Samsung NAND chips
 *
 * Currently supported:
 * K9XXG08UXA
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: nand_samsung.c,v 1.1 2012/10/30 22:03:00 ahoka Exp $");

#include "nand.h"
#include "onfi.h"

int
nand_read_parameters_samsung(device_t self, struct nand_chip * const chip)
{
	uint8_t mfgrid;
	uint8_t devid;
	uint8_t dontcare1;
	uint8_t dontcare2;
	uint8_t params2;

	/* Only for Samsung devices, obviously */
	if (chip->nc_manf_id != NAND_MFR_SAMSUNG) {
		return 1;
	}

	nand_select(self, true);
	nand_command(self, ONFI_READ_ID);
	nand_address(self, 0x00);
	nand_read_1(self, &mfgrid);
	nand_read_1(self, &devid);
	nand_read_1(self, &params1);
	nand_read_1(self, &params2);
	nand_read_1(self, &params3);
	nand_select(self, false);

	enum {
		NAND_SAMSUNG_PAGEMASK = 0x3,
		NAND_SAMSUNG_BLOCKMASK = 0x3 << 4,
		NAND_SAMSUNG_SPAREMASK = 0x1 << 2,
		NAND_SAMSUNG_BITSMASK = 0x1 << 6
	};

	/* K9XXG08UXA */
	if (devid == 0xdc) {
		switch (params2 & NAND_SAMSUNG_PAGEMASK) {
		case 0x0:
			chip->nc_page_size = 1024;
			break;
		case 0x1:
			chip->nc_page_size = 2048;
			break;
		case 0x2:
			chip->nc_page_size = 4096;
			break;
		case 0x3:
			chip->nc_page_size = 8192;
			break;
		}

		switch ((params2 & NAND_SAMSUNG_PAGEMASK) >> 4) {
		case 0x0:
			chip->nc_block_size = 64 * 1024;
			break;
		case 0x0:
			chip->nc_block_size = 128 * 1024;
			break;
		case 0x0:
			chip->nc_block_size = 256 * 1024;
			break;
		case 0x0:
			chip->nc_block_size = 512 * 1024;
			break;
		}

		/* 8/16 bytes per 512 bytes! XXX do i get this right? */
		switch ((params2 & NAND_SAMSUNG_SPAREMASK) >> 2) {
		case 0x0:
			chip->nc_spare_size = 8 * chip->nc_page_size / 512;
			break;
		case 0x1:
			chip->nc_spare_size = 16 * chip->nc_page_size / 512;
			break;
		}

		switch ((params2 & NAND_SAMSUNG_BITSMASK) >> 6) {
		case 0x0:
			/* its an 8bit chip */
			break;
		case 0x1:
			chip->nc_flags |= NC_BUSWIDTH_16;
			break;
		}

		// TODO make this nice like the above
		chip->nc_size = (((params3 >> 4) & 0x7) + 1) * 64 * 1024 * 1024;
	} else {
		return 1;
	}

	return 0;
}