Skip to content

F
FMC Software Support
Commit deabe09a authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

doc: fix kernel comment according to 6.0 kernel-doc 

Signed-off-by: Federico Vaga's avatarFederico Vaga <federico.vaga@cern.ch>
parent cf09012a
Hide whitespace changes
Inline Side-by-side
Showing with 50 additions and 38 deletions
drivers/fmc/fmc-core.c
View file @ deabe09a
...@@ -24,7 +24,7 @@ static struct class fmc_class; ...@@ -24,7 +24,7 @@ static struct class fmc_class;
/** /**
* Check if an FMC slot is present in a carrier slot * fmc_slot_present() - Check if an FMC slot is present in a carrier slot
* @slot: FMC slot to verify * @slot: FMC slot to verify
* *
* Return: 1 if the slot is present, 0 if it is not present, otherwise a * Return: 1 if the slot is present, 0 if it is not present, otherwise a
...@@ -125,7 +125,7 @@ static const struct device_type fmc_carrier_type = { ...@@ -125,7 +125,7 @@ static const struct device_type fmc_carrier_type = {
/** /**
* Generate a device ID for slot * fmc_slot_id() - Generate a device ID for slot
* @carrier: an FMC carrier instance (already configured) * @carrier: an FMC carrier instance (already configured)
* @lun slot Logical Unit Number * @lun slot Logical Unit Number
* *
...@@ -138,7 +138,7 @@ static inline uint32_t fmc_slot_id(struct fmc_carrier *carrier, ...@@ -138,7 +138,7 @@ static inline uint32_t fmc_slot_id(struct fmc_carrier *carrier,
} }
/** /**
* Add an initialized slot to the given carrier * fmc_carrier_add_slot() - Add an initialized slot to the given carrier
* @carrier: the carrier instance * @carrier: the carrier instance
* @info: slot information from the carrier driver * @info: slot information from the carrier driver
* *
...@@ -217,9 +217,10 @@ err_ida: ...@@ -217,9 +217,10 @@ err_ida:
} }
/** /**
* Remove the given slot from its carrier (previously added with * fmc_carrier_del_slot() - Remove the given slot from its carrier
* fmc_carrier_add_slot())
* @slot: a previously added slot * @slot: a previously added slot
*
* NOTE: previously added with fmc_carrier_add_slot()
*/ */
static void fmc_carrier_del_slot(struct fmc_slot *slot) static void fmc_carrier_del_slot(struct fmc_slot *slot)
{ {
...@@ -231,7 +232,7 @@ static void fmc_carrier_del_slot(struct fmc_slot *slot) ...@@ -231,7 +232,7 @@ static void fmc_carrier_del_slot(struct fmc_slot *slot)
} }
/** /**
* Register an FMC carrier device * fmc_carrier_register() - Register an FMC carrier device
* @parent: the parent device for the FMC carrier * @parent: the parent device for the FMC carrier
* @ops: carrier operations * @ops: carrier operations
* @nr_slot: number of available slots * @nr_slot: number of available slots
...@@ -329,7 +330,7 @@ err_ida: ...@@ -329,7 +330,7 @@ err_ida:
EXPORT_SYMBOL(fmc_carrier_register); EXPORT_SYMBOL(fmc_carrier_register);
/** /**
* Unregister an FMC carrier instance * fmc_carrier_unregister() - Unregister an FMC carrier instance
* @parent: parent device * @parent: parent device
* *
* Return: 0 on success, otherwise a negative error code * Return: 0 on success, otherwise a negative error code
...@@ -352,6 +353,10 @@ int fmc_carrier_unregister(struct device *parent) ...@@ -352,6 +353,10 @@ int fmc_carrier_unregister(struct device *parent)
EXPORT_SYMBOL(fmc_carrier_unregister); EXPORT_SYMBOL(fmc_carrier_unregister);
/** /**
* __fmc_class_find_carrier_match() - match device with carrier
* @dev: fmc carrier from the loop
* @data: fmc slot looking for its parent
*
* A device matches only when the device instance is a carrier and it has * A device matches only when the device instance is a carrier and it has
* the parent we asked. * the parent we asked.
*/ */
...@@ -364,7 +369,7 @@ static int __fmc_class_find_carrier_match(struct device *dev, ...@@ -364,7 +369,7 @@ static int __fmc_class_find_carrier_match(struct device *dev,
} }
/** /**
* Retrieve, and pin, the FMC carrier associated to the given device * fmc_carrier_get() - Retrieve, and pin, the FMC carrier of a device
* @parent: parent device * @parent: parent device
* *
* This pointer must be released with a call to fmc_carrier_put() * This pointer must be released with a call to fmc_carrier_put()
...@@ -382,7 +387,7 @@ struct fmc_carrier *fmc_carrier_get(struct device *parent) ...@@ -382,7 +387,7 @@ struct fmc_carrier *fmc_carrier_get(struct device *parent)
EXPORT_SYMBOL(fmc_carrier_get); EXPORT_SYMBOL(fmc_carrier_get);
/** /**
* Release the given FMC carrier * fmc_carrier_put() - Release the given FMC carrier
* @carrier: FMC carrier to release * @carrier: FMC carrier to release
*/ */
void fmc_carrier_put(struct fmc_carrier *carrier) void fmc_carrier_put(struct fmc_carrier *carrier)
...@@ -392,8 +397,7 @@ void fmc_carrier_put(struct fmc_carrier *carrier) ...@@ -392,8 +397,7 @@ void fmc_carrier_put(struct fmc_carrier *carrier)
EXPORT_SYMBOL(fmc_carrier_put); EXPORT_SYMBOL(fmc_carrier_put);
/** /**
* Retrieve, and pin, the FMC slot associated to the given set * fmc_slot_get() - Retrieve, and pin, the FMC slot of a slot
* of device, I2C adapter and geographical address
* @parent: parent device * @parent: parent device
* @lun: Slot Logical Unit Number * @lun: Slot Logical Unit Number
* *
...@@ -429,7 +433,7 @@ struct fmc_slot *fmc_slot_get(struct device *parent, ...@@ -429,7 +433,7 @@ struct fmc_slot *fmc_slot_get(struct device *parent,
EXPORT_SYMBOL(fmc_slot_get); EXPORT_SYMBOL(fmc_slot_get);
/** /**
* Releases the given FMC slot * fmc_slot_put() - Releases the given FMC slot
* @slot: FMC slot to release * @slot: FMC slot to release
*/ */
void fmc_slot_put(struct fmc_slot *slot) void fmc_slot_put(struct fmc_slot *slot)
......
drivers/fmc/fmc-eeprom.c
View file @ deabe09a
...@@ -19,7 +19,7 @@ ...@@ -19,7 +19,7 @@
#define FRU_EEPROM_NAME "fru_eeprom" #define FRU_EEPROM_NAME "fru_eeprom"
/** /**
* Default EEPROM type according to the standard. * FMC_EEPROM_TYPE_DEFAULT - Default EEPROM type according to the standard.
*/ */
#define FMC_EEPROM_TYPE_DEFAULT "24c02" #define FMC_EEPROM_TYPE_DEFAULT "24c02"
...@@ -38,7 +38,7 @@ static void fmc_slot_eeprom_setup(struct memory_accessor *macc, void *context) ...@@ -38,7 +38,7 @@ static void fmc_slot_eeprom_setup(struct memory_accessor *macc, void *context)
slot->macc = macc; slot->macc = macc;
} }
/** /*
* Default configuration for AT24C02 EEPROM type * Default configuration for AT24C02 EEPROM type
*/ */
static const struct at24_platform_data at24_24c02 = { static const struct at24_platform_data at24_24c02 = {
...@@ -50,7 +50,7 @@ static const struct at24_platform_data at24_24c02 = { ...@@ -50,7 +50,7 @@ static const struct at24_platform_data at24_24c02 = {
#endif /* KERNEL_VERSION(4, 6, 0) <= LINUX_VERSION_CODE */ #endif /* KERNEL_VERSION(4, 6, 0) <= LINUX_VERSION_CODE */
/** /**
* Initialize I2C EEPROM info with standard values * fmc_slot_eeprom_init() - Initialize I2C EEPROM info with standard values
*/ */
static void fmc_slot_eeprom_init(struct fmc_slot *slot, static void fmc_slot_eeprom_init(struct fmc_slot *slot,
struct i2c_board_info *info, struct i2c_board_info *info,
...@@ -104,11 +104,13 @@ int fmc_nvmem_device_find_match(struct device *dev, const void *data) ...@@ -104,11 +104,13 @@ int fmc_nvmem_device_find_match(struct device *dev, const void *data)
} }
/** /**
* Read from EEPROM * fmc_slot_eeprom_read() - Read from EEPROM
* @slot: FMC slot instance * @slot: FMC slot instance
* @buf: destination buffer * @buf: destination buffer
* @offset: EEPROM offset in bytes * @offset: EEPROM offset in bytes
* @count: how many bytes to read * @count: how many bytes to read
*
* Return: the number of bytes read
*/ */
ssize_t fmc_slot_eeprom_read(struct fmc_slot *slot, ssize_t fmc_slot_eeprom_read(struct fmc_slot *slot,
void *buf, off_t offset, size_t count) void *buf, off_t offset, size_t count)
...@@ -130,7 +132,7 @@ ssize_t fmc_slot_eeprom_read(struct fmc_slot *slot, ...@@ -130,7 +132,7 @@ ssize_t fmc_slot_eeprom_read(struct fmc_slot *slot,
EXPORT_SYMBOL(fmc_slot_eeprom_read); EXPORT_SYMBOL(fmc_slot_eeprom_read);
/** /**
* Add EEPROM which will be associated to the given FMC slot * __fmc_slot_eeprom_add() - Add EEPROM to the given FMC slot
* @slot: FMC slot instance * @slot: FMC slot instance
* @info: I2C EEPROM information * @info: I2C EEPROM information
* *
...@@ -202,7 +204,7 @@ static int __fmc_slot_eeprom_add(struct fmc_slot *slot, ...@@ -202,7 +204,7 @@ static int __fmc_slot_eeprom_add(struct fmc_slot *slot,
} }
/** /**
* Add EEPROM to a given FMC slot * fmc_slot_eeprom_add() - Add EEPROM to the given FMC slot
* @slot: FMC slot instance * @slot: FMC slot instance
* *
* Return: 0 on success, otherwise a negative error number * Return: 0 on success, otherwise a negative error number
...@@ -216,7 +218,7 @@ int fmc_slot_eeprom_add(struct fmc_slot *slot) ...@@ -216,7 +218,7 @@ int fmc_slot_eeprom_add(struct fmc_slot *slot)
} }
/** /**
* Remove EEPROM associated to the given FMC slot * fmc_slot_eeprom_del() - Remove EEPROM associated to the given FMC slot
* @slot: FMC slot instance * @slot: FMC slot instance
* *
* This should be used only by the FMC framework itself. But, this is also * This should be used only by the FMC framework itself. But, this is also
...@@ -243,7 +245,7 @@ void fmc_slot_eeprom_del(struct fmc_slot *slot) ...@@ -243,7 +245,7 @@ void fmc_slot_eeprom_del(struct fmc_slot *slot)
} }
/** /**
* Replace current EEPROM instance with a given one * fmc_slot_eeprom_replace() - Replace current EEPROM instance with a given one
* @slot: FMC slot instance * @slot: FMC slot instance
* @info: I2C EEPROM information * @info: I2C EEPROM information
* *
...@@ -326,7 +328,7 @@ int fmc_slot_eeprom_type_set(struct fmc_slot *slot, const char *type) ...@@ -326,7 +328,7 @@ int fmc_slot_eeprom_type_set(struct fmc_slot *slot, const char *type)
EXPORT_SYMBOL(fmc_slot_eeprom_type_set); EXPORT_SYMBOL(fmc_slot_eeprom_type_set);
/** /**
* Check if an FMC mezzanine in the FMC slot has a valid FRU * fmc_slot_fru_valid() - Check if an FMC mezzanine has a valid FRU
* @slot: FMC slot to verify * @slot: FMC slot to verify
* *
* Return: 1 if the slot is present, otherwise 0 * Return: 1 if the slot is present, otherwise 0
......
include/linux/fmc.h
View file @ deabe09a
...@@ -34,7 +34,7 @@ struct fmc_slot; ...@@ -34,7 +34,7 @@ struct fmc_slot;
#define FMC_EEPROM_ADDR_SPACE 0x50 #define FMC_EEPROM_ADDR_SPACE 0x50
/** /**
* Convert a Geographical Address suffix into an I2C address * fmc_ga_to_i2c_addr() - Convert a Geographical Address into an I2C address
* @ga: geographical address * @ga: geographical address
* *
* Return: an I2C address suffix * Return: an I2C address suffix
...@@ -51,7 +51,7 @@ static inline uint8_t fmc_ga_to_i2c_addr(uint8_t ga) ...@@ -51,7 +51,7 @@ static inline uint8_t fmc_ga_to_i2c_addr(uint8_t ga)
} }
/** /**
* Fix given address with the FMC geographical address * fmc_slot_i2c_address() - Fix given address with the FMC geographical address
* @addr: an address * @addr: an address
* @ga: geographical address to apply * @ga: geographical address to apply
* *
...@@ -97,7 +97,7 @@ struct fmc_slot { ...@@ -97,7 +97,7 @@ struct fmc_slot {
}; };
/** /**
* struct fmc_flot_info - information for adding new slots * struct fmc_slot_info - information for adding new slots
* @i2c_bus_nr: I2C bus number * @i2c_bus_nr: I2C bus number
* @ga: Geographical Address according to FMC standard * @ga: Geographical Address according to FMC standard
* @lun: slot logical unit number * @lun: slot logical unit number
...@@ -109,7 +109,7 @@ struct fmc_slot_info { ...@@ -109,7 +109,7 @@ struct fmc_slot_info {
}; };
/** /**
* Get an FMC slot from its Linux device * to_fmc_slot() - Get an FMC slot from its Linux device
* @dev_ptr: pointer to device structure * @dev_ptr: pointer to device structure
* *
* Return: correspondent fmc_carrier structure * Return: correspondent fmc_carrier structure
...@@ -160,7 +160,7 @@ struct fmc_carrier { ...@@ -160,7 +160,7 @@ struct fmc_carrier {
}; };
/** /**
* Get an FMC carrier from its Linux device * to_fmc_carrier() - Get an FMC carrier from its Linux device
* @dev_ptr: pointer to device structure * @dev_ptr: pointer to device structure
* *
* Return: correspondent fmc_carrier structure * Return: correspondent fmc_carrier structure
......
include/uapi/linux/ipmi/fru.h
View file @ deabe09a
...@@ -113,7 +113,7 @@ enum fru_type { ...@@ -113,7 +113,7 @@ enum fru_type {
}; };
/** /**
* Get the board info area * fru_get_board_area() - Get the board info area
* @header: FRU header pointer * @header: FRU header pointer
* *
* Return: pointer to the board info area * Return: pointer to the board info area
...@@ -126,7 +126,7 @@ static inline struct fru_board_info_area *fru_get_board_area( ...@@ -126,7 +126,7 @@ static inline struct fru_board_info_area *fru_get_board_area(
} }
/** /**
* Get the FRU section type * fru_type() - Get the FRU section type
* @tl: the type-length * @tl: the type-length
* *
* Return: FRU section type * Return: FRU section type
...@@ -137,7 +137,7 @@ static inline int fru_type(struct fru_type_length *tl) ...@@ -137,7 +137,7 @@ static inline int fru_type(struct fru_type_length *tl)
} }
/** /**
* Get the FRU section length * fru_length() - Get the FRU section length
* @tl: the type-length * @tl: the type-length
* *
* Return: FRU section length * Return: FRU section length
...@@ -148,7 +148,7 @@ static inline int fru_length(struct fru_type_length *tl) ...@@ -148,7 +148,7 @@ static inline int fru_length(struct fru_type_length *tl)
} }
/** /**
* Compute the string value lenght from type-length * fru_strlen() - Compute the string value length from type-length
* @tl: the type-length * @tl: the type-length
* *
* Return: string length * Return: string length
...@@ -161,7 +161,7 @@ static inline int fru_strlen(struct fru_type_length *tl) ...@@ -161,7 +161,7 @@ static inline int fru_strlen(struct fru_type_length *tl)
} }
/** /**
* Copy the string value from type-length * fru_strcpy() - Copy the string value from type-length
* @dest: destination string buffer * @dest: destination string buffer
* @tl: the type-length * @tl: the type-length
* *
...@@ -176,7 +176,7 @@ static inline char *fru_strcpy(char *dest, struct fru_type_length *tl) ...@@ -176,7 +176,7 @@ static inline char *fru_strcpy(char *dest, struct fru_type_length *tl)
} }
/** /**
* Retrieve the next type-length structure * fru_next_tl() - Retrieve the next type-length structure
* @tl: the current type-length * @tl: the current type-length
* *
* Return: the next type-length structure * Return: the next type-length structure
...@@ -187,10 +187,12 @@ static inline struct fru_type_length *fru_next_tl(struct fru_type_length *tl) ...@@ -187,10 +187,12 @@ static inline struct fru_type_length *fru_next_tl(struct fru_type_length *tl)
} }
/** /**
* Check if there are no more type-length * fru_is_eof() - fru_is_eofCheck if there are no more type-length
* @tl: the current type-length * @tl: the current type-length
* *
* Return: 1 if the current type-length is the last one * Return:
* - 1 if the current type-length is the last one
* - 0 if the current type-length is not the last one
*/ */
static inline int fru_is_eof(struct fru_type_length *tl) static inline int fru_is_eof(struct fru_type_length *tl)
{ {
...@@ -198,10 +200,12 @@ static inline int fru_is_eof(struct fru_type_length *tl) ...@@ -198,10 +200,12 @@ static inline int fru_is_eof(struct fru_type_length *tl)
} }
/** /**
* Validate FRU header checksum * fru_header_cksum_ok() - Validate FRU header checksum
* @header: FRU header pointer * @header: FRU header pointer
* *
* Return: 1 if the FRU header checksum is correct * Return:
* - 1 if the FRU header checksum is correct
* - 0 if the FRU header checksum is not correct
*/ */
static inline int fru_header_cksum_ok(struct fru_common_header *header) static inline int fru_header_cksum_ok(struct fru_common_header *header)
{ {
...@@ -215,10 +219,12 @@ static inline int fru_header_cksum_ok(struct fru_common_header *header) ...@@ -215,10 +219,12 @@ static inline int fru_header_cksum_ok(struct fru_common_header *header)
} }
/** /**
* Validate Board Info Area checksum * fru_bia_cksum_ok() -Validate Board Info Area checksum
* @bia: board info area pointer * @bia: board info area pointer
* *
* Return: 1 if the FRU board info area checksum is correct * Return:
* - 1 if the FRU board info area checksum is correct
* - 0 if the FRU board info area checksum is not correct
*/ */
static inline int fru_bia_cksum_ok(struct fru_board_info_area *bia) static inline int fru_bia_cksum_ok(struct fru_board_info_area *bia)
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment