X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fflash%2Fnor%2Fdriver.h;h=8f2e1cc2328b4bb4147344121627be4b4ee7be0e;hb=34f3e84d690d6466267872d434f291756c3a685d;hp=afd05285a2766fcd9f3e586a1d7338a8740b0fc5;hpb=4f9a9b8ebae8425eda3a71ccb782789cd3b8f6b7;p=openocd.git diff --git a/src/flash/nor/driver.h b/src/flash/nor/driver.h index afd05285a2..8f2e1cc232 100644 --- a/src/flash/nor/driver.h +++ b/src/flash/nor/driver.h @@ -18,8 +18,9 @@ * 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. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * ***************************************************************************/ + #ifndef FLASH_NOR_DRIVER_H #define FLASH_NOR_DRIVER_H @@ -48,14 +49,18 @@ struct flash_bank; * corresponding static flash_driver_callback() * routine in flash.c. */ -struct flash_driver -{ +struct flash_driver { /** * Gives a human-readable name of this flash driver, * This field is used to select and initialize the driver. */ const char *name; + /** + * Gives a human-readable description of arguments. + */ + const char *usage; + /** * An array of driver-specific commands to register. When called * during the "flash bank" command, the driver can register addition @@ -132,7 +137,7 @@ struct flash_driver * @returns ERROR_OK if successful; otherwise, an error code. */ int (*write)(struct flash_bank *bank, - uint8_t *buffer, uint32_t offset, uint32_t count); + const uint8_t *buffer, uint32_t offset, uint32_t count); /** * Read data from the flash. Note CPU address will be @@ -195,7 +200,7 @@ struct flash_driver /** * A more gentle flavor of filash_driver_s::probe, performing * setup with less noise. Generally, driver routines should test - * to seee if the bank has already been probed; if it has, the + * to see if the bank has already been probed; if it has, the * driver probably should not perform its probe a second time. * * This callback is often called from the inside of other @@ -208,7 +213,8 @@ struct flash_driver int (*auto_probe)(struct flash_bank *bank); }; -#define FLASH_BANK_COMMAND_HANDLER(name) static __FLASH_BANK_COMMAND(name) +#define FLASH_BANK_COMMAND_HANDLER(name) \ + static __FLASH_BANK_COMMAND(name) /** * Find a NOR flash driver by its name. @@ -217,4 +223,4 @@ struct flash_driver */ struct flash_driver *flash_driver_find_by_name(const char *name); -#endif // FLASH_NOR_DRIVER_H +#endif /* FLASH_NOR_DRIVER_H */