path: root/src/systemcmds/eeprom/eeprom.c

/****************************************************************************
 *
 *   Copyright (C) 2012 PX4 Development Team. All rights reserved.
 *   Author: Lorenz Meier <lm@inf.ethz.ch>
 *
 * 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.
 * 3. Neither the name PX4 nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
 * COPYRIGHT OWNER 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.
 *
 ****************************************************************************/

/**
 * @file eeprom.c
 *
 * EEPROM service and utility app.
 */

#include <nuttx/config.h>

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdbool.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/mount.h>
#include <sys/ioctl.h>
#include <sys/stat.h>

#include <nuttx/i2c.h>
#include <nuttx/mtd.h>
#include <nuttx/fs/nxffs.h>
#include <nuttx/fs/ioctl.h>

#include <arch/board/board.h>

#include "systemlib/systemlib.h"
#include "systemlib/param/param.h"
#include "systemlib/err.h"

#ifndef PX4_I2C_BUS_ONBOARD
#  error PX4_I2C_BUS_ONBOARD not defined, cannot locate onboard EEPROM
#endif

__EXPORT int eeprom_main(int argc, char *argv[]);

static void	eeprom_attach(void);
static void	eeprom_start(void);
static void	eeprom_erase(void);
static void	eeprom_ioctl(unsigned operation);
static void	eeprom_save(const char *name);
static void	eeprom_load(const char *name);
static void	eeprom_test(void);

static bool attached = false;
static bool started = false;
static struct mtd_dev_s *eeprom_mtd;

int eeprom_main(int argc, char *argv[])
{
	if (argc >= 2) {
		if (!strcmp(argv[1], "start"))
			eeprom_start();

		if (!strcmp(argv[1], "save_param"))
			eeprom_save(argv[2]);

		if (!strcmp(argv[1], "load_param"))
			eeprom_load(argv[2]);

		if (!strcmp(argv[1], "erase"))
			eeprom_erase();

		if (!strcmp(argv[1], "test"))
			eeprom_test();

		if (0) {	/* these actually require a file on the filesystem... */

			if (!strcmp(argv[1], "reformat"))
				eeprom_ioctl(FIOC_REFORMAT);

			if (!strcmp(argv[1], "repack"))
				eeprom_ioctl(FIOC_OPTIMIZE);
		}
	}

	errx(1, "expected a command, try 'start'\n\t'save_param /eeprom/parameters'\n\t'load_param /eeprom/parameters'\n\t'erase'\n");
}


static void
eeprom_attach(void)
{
	/* find the right I2C */
	struct i2c_dev_s *i2c = up_i2cinitialize(PX4_I2C_BUS_ONBOARD);
	/* this resets the I2C bus, set correct bus speed again */
	I2C_SETFREQUENCY(i2c, 400000);

	if (i2c == NULL)
		errx(1, "failed to locate I2C bus");

	/* start the MTD driver, attempt 5 times */
	for (int i = 0; i < 5; i++) {
		eeprom_mtd = at24c_initialize(i2c);
		if (eeprom_mtd) {
			/* abort on first valid result */
			if (i > 0) {
				warnx("warning: EEPROM needed %d attempts to attach", i+1);
			}
			break;
		}
	}

	/* if last attempt is still unsuccessful, abort */
	if (eeprom_mtd == NULL)
		errx(1, "failed to initialize EEPROM driver");

	attached = true;
}

static void
eeprom_start(void)
{
	int ret;

	if (started)
		errx(1, "EEPROM already mounted");

	if (!attached)
		eeprom_attach();

	/* start NXFFS */
	ret = nxffs_initialize(eeprom_mtd);

	if (ret < 0)
		errx(1, "failed to initialize NXFFS - erase EEPROM to reformat");

	/* mount the EEPROM */
	ret = mount(NULL, "/eeprom", "nxffs", 0, NULL);

	if (ret < 0)
		errx(1, "failed to mount /eeprom - erase EEPROM to reformat");

	started = true;
	warnx("mounted EEPROM at /eeprom");
	exit(0);
}

extern int at24c_nuke(void);

static void
eeprom_erase(void)
{
	if (!attached)
		eeprom_attach();

	if (at24c_nuke())
		errx(1, "erase failed");

	errx(0, "erase done, reboot now");
}

static void
eeprom_ioctl(unsigned operation)
{
	int fd;

	fd = open("/eeprom/.", 0);

	if (fd < 0)
		err(1, "open /eeprom");

	if (ioctl(fd, operation, 0) < 0)
		err(1, "ioctl");

	exit(0);
}

static void
eeprom_save(const char *name)
{
	if (!started)
		errx(1, "must be started first");

	if (!name)
		err(1, "missing argument for device name, try '/eeprom/parameters'");

	warnx("WARNING: 'eeprom save_param' deprecated - use 'param save' instead");

	/* delete the file in case it exists */
	unlink(name);

	/* create the file */
	int fd = open(name, O_WRONLY | O_CREAT | O_EXCL);

	if (fd < 0)
		err(1, "opening '%s' failed", name);

	int result = param_export(fd, false);
	close(fd);

	if (result < 0) {
		unlink(name);
		errx(1, "error exporting to '%s'", name);
	}

	exit(0);
}

static void
eeprom_load(const char *name)
{
	if (!started)
		errx(1, "must be started first");

	if (!name)
		err(1, "missing argument for device name, try '/eeprom/parameters'");

	warnx("WARNING: 'eeprom load_param' deprecated - use 'param load' instead");

	int fd = open(name, O_RDONLY);

	if (fd < 0)
		err(1, "open '%s'", name);

	int result = param_load(fd);
	close(fd);

	if (result < 0)
		errx(1, "error importing from '%s'", name);

	exit(0);
}

extern void at24c_test(void);

static void
eeprom_test(void)
{
	at24c_test();
	exit(0);
}