/*
 * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 */

/* Interface for access various storage device */

#ifndef CHROMEOS_FIRMWARE_STORAGE_H_
#define CHROMEOS_FIRMWARE_STORAGE_H_

#include <chromeos/fdt_decode.h>

#ifndef CONFIG_HARDWARE_MAPPED_SPI
typedef void *read_buf_type;
#define BT_EXTRA
#define FREE_IF_NEEDED(p) free(p)
#else
typedef void **read_buf_type;
#define BT_EXTRA (read_buf_type) &
#define FREE_IF_NEEDED(p)
#endif

/**
 * These read or write [count] bytes starting from [offset] of storage into or
 * from the [buf].
 *
 * @param file is the device you access
 * @param offset is where on the device you access
 * @param count is the amount of data in byte you access
 * @param buf is the data that these functions read from or write to
 * @return 0 if it succeeds, non-zero if it fails
 */
typedef struct firmware_storage_t {
	int (*read)(struct firmware_storage_t *file,
			uint32_t offset, uint32_t count, read_buf_type buf);
	int (*write)(struct firmware_storage_t *file,
			uint32_t offset, uint32_t count, void *buf);
	int (*close)(struct firmware_storage_t *file);

	void *context; /* device driver's private data */
} firmware_storage_t;

/**
 * This opens SPI flash device
 *
 * @param file - the opened SPI flash device
 * @return 0 if it succeeds, non-zero if it fails
 */
int firmware_storage_open_spi(firmware_storage_t *file);

int firmware_storage_open_twostop(firmware_storage_t *file,
		struct twostop_fmap *fmap);

#endif /* CHROMEOS_FIRMWARE_STORAGE_H_ */