cosmetic: image: Fix comments and the order of definitions
Fix some comments about functions. Move genimg_get_comp_name() above genimg_get_short_name() because genimg_get_comp_name() is related to get_table_entry_name(). Signed-off-by: Naoki Hayama <naoki.hayama@lineo.co.jp> Reviewed-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
parent
ad5fb9f2e6
commit
898a084953
|
|
@ -801,14 +801,14 @@ static const char *unknown_msg(enum ih_category category)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* get_cat_table_entry_name - translate entry id to long name
|
* genimg_get_cat_name - translate entry id to long name
|
||||||
* @category: category to look up (enum ih_category)
|
* @category: category to look up (enum ih_category)
|
||||||
* @id: entry id to be translated
|
* @id: entry id to be translated
|
||||||
*
|
*
|
||||||
* This will scan the translation table trying to find the entry that matches
|
* This will scan the translation table trying to find the entry that matches
|
||||||
* the given id.
|
* the given id.
|
||||||
*
|
*
|
||||||
* @retur long entry name if translation succeeds; error string on failure
|
* @return long entry name if translation succeeds; error string on failure
|
||||||
*/
|
*/
|
||||||
const char *genimg_get_cat_name(enum ih_category category, uint id)
|
const char *genimg_get_cat_name(enum ih_category category, uint id)
|
||||||
{
|
{
|
||||||
|
|
@ -825,14 +825,14 @@ const char *genimg_get_cat_name(enum ih_category category, uint id)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* get_cat_table_entry_short_name - translate entry id to short name
|
* genimg_get_cat_short_name - translate entry id to short name
|
||||||
* @category: category to look up (enum ih_category)
|
* @category: category to look up (enum ih_category)
|
||||||
* @id: entry id to be translated
|
* @id: entry id to be translated
|
||||||
*
|
*
|
||||||
* This will scan the translation table trying to find the entry that matches
|
* This will scan the translation table trying to find the entry that matches
|
||||||
* the given id.
|
* the given id.
|
||||||
*
|
*
|
||||||
* @retur short entry name if translation succeeds; error string on failure
|
* @return short entry name if translation succeeds; error string on failure
|
||||||
*/
|
*/
|
||||||
const char *genimg_get_cat_short_name(enum ih_category category, uint id)
|
const char *genimg_get_cat_short_name(enum ih_category category, uint id)
|
||||||
{
|
{
|
||||||
|
|
@ -918,6 +918,12 @@ const char *genimg_get_type_name(uint8_t type)
|
||||||
return (get_table_entry_name(uimage_type, "Unknown Image", type));
|
return (get_table_entry_name(uimage_type, "Unknown Image", type));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const char *genimg_get_comp_name(uint8_t comp)
|
||||||
|
{
|
||||||
|
return (get_table_entry_name(uimage_comp, "Unknown Compression",
|
||||||
|
comp));
|
||||||
|
}
|
||||||
|
|
||||||
static const char *genimg_get_short_name(const table_entry_t *table, int val)
|
static const char *genimg_get_short_name(const table_entry_t *table, int val)
|
||||||
{
|
{
|
||||||
table = get_table_entry(table, val);
|
table = get_table_entry(table, val);
|
||||||
|
|
@ -935,12 +941,6 @@ const char *genimg_get_type_short_name(uint8_t type)
|
||||||
return genimg_get_short_name(uimage_type, type);
|
return genimg_get_short_name(uimage_type, type);
|
||||||
}
|
}
|
||||||
|
|
||||||
const char *genimg_get_comp_name(uint8_t comp)
|
|
||||||
{
|
|
||||||
return (get_table_entry_name(uimage_comp, "Unknown Compression",
|
|
||||||
comp));
|
|
||||||
}
|
|
||||||
|
|
||||||
const char *genimg_get_comp_short_name(uint8_t comp)
|
const char *genimg_get_comp_short_name(uint8_t comp)
|
||||||
{
|
{
|
||||||
return genimg_get_short_name(uimage_comp, comp);
|
return genimg_get_short_name(uimage_comp, comp);
|
||||||
|
|
|
||||||
|
|
@ -563,6 +563,7 @@ int genimg_get_cat_count(enum ih_category category);
|
||||||
/**
|
/**
|
||||||
* genimg_get_cat_desc() - Get the description of a category
|
* genimg_get_cat_desc() - Get the description of a category
|
||||||
*
|
*
|
||||||
|
* @category: Category to check
|
||||||
* @return the description of a category, e.g. "architecture". This
|
* @return the description of a category, e.g. "architecture". This
|
||||||
* effectively converts the enum to a string.
|
* effectively converts the enum to a string.
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue