openocd: fix incorrect doxygen comments

[openocd.git] / src / flash / nor / dsp5680xx_flash.c

diff --git a/src/flash/nor/dsp5680xx_flash.c b/src/flash/nor/dsp5680xx_flash.c
index 62df9ce3063c6b681b1ac11de25aab690b99d0d2..49022825ed1a76daa4d4bdb82336d44a87e71efc 100644 (file)
--- a/src/flash/nor/dsp5680xx_flash.c
+++ b/src/flash/nor/dsp5680xx_flash.c
@@ -18,9 +18,7 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 /**
@@ -50,9 +48,8 @@ static int dsp5680xx_build_sector_list(struct flash_bank *bank)
        uint32_t offset = HFM_FLASH_BASE_ADDR;
 
        bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
-       int i;
 
-       for (i = 0; i < bank->num_sectors; ++i) {
+       for (unsigned int i = 0; i < bank->num_sectors; ++i) {
                bank->sectors[i].offset = i * HFM_SECTOR_SIZE;
                bank->sectors[i].size = HFM_SECTOR_SIZE;
                offset += bank->sectors[i].size;
@@ -110,7 +107,7 @@ static int dsp5680xx_flash_protect_check(struct flash_bank *bank)
 }
 
 /**
- * Protection funcionality is not implemented.
+ * Protection functionality is not implemented.
  * The current implementation applies/removes security on the chip.
  * The chip is effectively secured/unsecured after the first reset
  * following the execution of this function.
@@ -122,8 +119,8 @@ static int dsp5680xx_flash_protect_check(struct flash_bank *bank)
  *
  * @return
  */
-static int dsp5680xx_flash_protect(struct flash_bank *bank, int set, int first,
-                                  int last)
+static int dsp5680xx_flash_protect(struct flash_bank *bank, int set,
+               unsigned int first, unsigned int last)
 {
 /**
  * This applies security to flash module after next reset, it does
@@ -156,7 +153,7 @@ static int dsp5680xx_flash_protect(struct flash_bank *bank, int set, int first,
  *
  * @return
  */
-static int dsp5680xx_flash_write(struct flash_bank *bank, uint8_t * buffer,
+static int dsp5680xx_flash_write(struct flash_bank *bank, const uint8_t *buffer,
                                 uint32_t offset, uint32_t count)
 {
        int retval;
@@ -193,19 +190,11 @@ static int dsp5680xx_probe(struct flash_bank *bank)
        return ERROR_OK;
 }
 
-static int dsp5680xx_flash_info(struct flash_bank *bank, char *buf,
-               int buf_size)
-{
-       snprintf(buf, buf_size,
-               "\ndsp5680xx flash driver info:\n - See comments in code.");
-       return ERROR_OK;
-}
-
 /**
  * The flash module (FM) on the dsp5680xx supports both individual sector
  * and mass erase of the flash memory.
- * If this function is called with @first == @last == 0 or if @first is the
- * first sector (#0) and @last is the last sector then the mass erase command
+ * If this function is called with @a first == @a last == 0 or if @a first is the
+ * first sector (#0) and @a last is the last sector then the mass erase command
  * is executed (much faster than erasing each sector individually).
  *
  * @param bank
@@ -214,7 +203,8 @@ static int dsp5680xx_flash_info(struct flash_bank *bank, char *buf,
  *
  * @return
  */
-static int dsp5680xx_flash_erase(struct flash_bank *bank, int first, int last)
+static int dsp5680xx_flash_erase(struct flash_bank *bank, unsigned int first,
+               unsigned int last)
 {
        int retval;
 
@@ -222,14 +212,14 @@ static int dsp5680xx_flash_erase(struct flash_bank *bank, int first, int last)
        if ((!(first | last)) || ((first == 0) && (last == (HFM_SECTOR_COUNT - 1))))
                last = HFM_SECTOR_COUNT - 1;
        if (retval == ERROR_OK)
-               for (int i = first; i <= last; i++)
+               for (unsigned int i = first; i <= last; i++)
                        bank->sectors[i].is_erased = 1;
        else
                /**
                 * If an error occurred unknown status
                 *is set even though some sector could have been correctly erased.
                 */
-               for (int i = first; i <= last; i++)
+               for (unsigned int i = first; i <= last; i++)
                        bank->sectors[i].is_erased = -1;
        return retval;
 }
@@ -266,7 +256,7 @@ static int dsp5680xx_flash_erase_check(struct flash_bank *bank)
        return retval;
 }
 
-struct flash_driver dsp5680xx_flash = {
+const struct flash_driver dsp5680xx_flash = {
        .name = "dsp5680xx_flash",
        .flash_bank_command = dsp5680xx_flash_bank_command,
        .erase = dsp5680xx_flash_erase,
@@ -277,5 +267,4 @@ struct flash_driver dsp5680xx_flash = {
        .auto_probe = dsp5680xx_probe,
        .erase_check = dsp5680xx_flash_erase_check,
        .protect_check = dsp5680xx_flash_protect_check,
-       .info = dsp5680xx_flash_info
 };