mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2026-04-24 10:49:54 +02:00
Randy Dunlap
c95de73da1
Correct most kernel-doc warnings in include/linux/mtd/spear_smi.h by adding a leading '@' to the description of struct members. Add a new description for the missing @np member. Warning: spear_smi.h:48 struct member 'name' not described in 'spear_smi_flash_info' Warning: spear_smi.h:48 struct member 'mem_base' not described in 'spear_smi_flash_info' Warning: spear_smi.h:48 struct member 'size' not described in 'spear_smi_flash_info' Warning: spear_smi.h:48 struct member 'partitions' not described in 'spear_smi_flash_info' Warning: spear_smi.h:48 struct member 'nr_partitions' not described in 'spear_smi_flash_info' Warning: spear_smi.h:48 struct member 'fast_mode' not described in 'spear_smi_flash_info' Warning: spear_smi.h:62 struct member 'clk_rate' not described in 'spear_smi_plat_data' Warning: spear_smi.h:62 struct member 'num_flashes' not described in 'spear_smi_plat_data' Warning: spear_smi.h:62 struct member 'board_flash_info' not described in 'spear_smi_plat_data' Warning: spear_smi.h:62 struct member 'np' not described in 'spear_smi_plat_data' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
67 lines
1.8 KiB
C
67 lines
1.8 KiB
C
/*
|
|
* Copyright © 2010 ST Microelectronics
|
|
* Shiraz Hashim <shiraz.linux.kernel@gmail.com>
|
|
*
|
|
* This file is licensed under the terms of the GNU General Public
|
|
* License version 2. This program is licensed "as is" without any
|
|
* warranty of any kind, whether express or implied.
|
|
*/
|
|
|
|
#ifndef __MTD_SPEAR_SMI_H
|
|
#define __MTD_SPEAR_SMI_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/mtd/mtd.h>
|
|
#include <linux/mtd/partitions.h>
|
|
#include <linux/platform_device.h>
|
|
#include <linux/of.h>
|
|
|
|
/* max possible slots for serial-nor flash chip in the SMI controller */
|
|
#define MAX_NUM_FLASH_CHIP 4
|
|
|
|
/* macro to define partitions for flash devices */
|
|
#define DEFINE_PARTS(n, of, s) \
|
|
{ \
|
|
.name = n, \
|
|
.offset = of, \
|
|
.size = s, \
|
|
}
|
|
|
|
/**
|
|
* struct spear_smi_flash_info - platform structure for passing flash
|
|
* information
|
|
*
|
|
* @name: name of the serial nor flash for identification
|
|
* @mem_base: the memory base on which the flash is mapped
|
|
* @size: size of the flash in bytes
|
|
* @partitions: parition details
|
|
* @nr_partitions: number of partitions
|
|
* @fast_mode: whether flash supports fast mode
|
|
*/
|
|
|
|
struct spear_smi_flash_info {
|
|
char *name;
|
|
unsigned long mem_base;
|
|
unsigned long size;
|
|
struct mtd_partition *partitions;
|
|
int nr_partitions;
|
|
u8 fast_mode;
|
|
};
|
|
|
|
/**
|
|
* struct spear_smi_plat_data - platform structure for configuring smi
|
|
*
|
|
* @clk_rate: clk rate at which SMI must operate
|
|
* @num_flashes: number of flashes present on board
|
|
* @board_flash_info: specific details of each flash present on board
|
|
* @np: array of DT node pointers for all possible flash chip devices
|
|
*/
|
|
struct spear_smi_plat_data {
|
|
unsigned long clk_rate;
|
|
int num_flashes;
|
|
struct spear_smi_flash_info *board_flash_info;
|
|
struct device_node *np[MAX_NUM_FLASH_CHIP];
|
|
};
|
|
|
|
#endif /* __MTD_SPEAR_SMI_H */
|