sys/contrib/octeon-sdk/cvmx-flash.h

   1 /***********************license start***************
   2  *  Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights
   3  *  reserved.
   4  *
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are
   8  *  met:
   9  *
  10  *      * Redistributions of source code must retain the above copyright
  11  *        notice, this list of conditions and the following disclaimer.
  12  *
  13  *      * Redistributions in binary form must reproduce the above
  14  *        copyright notice, this list of conditions and the following
  15  *        disclaimer in the documentation and/or other materials provided
  16  *        with the distribution.
  17  *
  18  *      * Neither the name of Cavium Networks nor the names of
  19  *        its contributors may be used to endorse or promote products
  20  *        derived from this software without specific prior written
  21  *        permission.
  22  *
  23  *  TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
  24  *  AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS
  25  *  OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH
  26  *  RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
  27  *  REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
  28  *  DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
  29  *  OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
  30  *  PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET
  31  *  POSSESSION OR CORRESPONDENCE TO DESCRIPTION.  THE ENTIRE RISK ARISING OUT
  32  *  OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
  33  *
  34  *
  35  *  For any questions regarding licensing please contact marketing@caviumnetworks.com
  36  *
  37  ***********************license end**************************************/
  38
  39
  40
  41
  42
  43
  44 /**
  45  * @file
  46  *
  47  * This file provides bootbus flash operations
  48  *
  49  * <hr>$Revision: 41586 $<hr>
  50  *
  51  *
  52  */
  53
  54
  55 #ifndef __CVMX_FLASH_H__
  56 #define __CVMX_FLASH_H__
  57
  58 #ifdef  __cplusplus
  59 extern "C" {
  60 #endif
  61
  62 typedef struct
  63 {
  64     int start_offset;
  65     int block_size;
  66     int num_blocks;
  67 } cvmx_flash_region_t;
  68
  69 /**
  70  * Initialize the flash access library
  71  */
  72 void cvmx_flash_initialize(void);
  73
  74 /**
  75  * Return a pointer to the flash chip
  76  *
  77  * @param chip_id Chip ID to return
  78  * @return NULL if the chip doesn't exist
  79  */
  80 void *cvmx_flash_get_base(int chip_id);
  81
  82 /**
  83  * Return the number of erasable regions on the chip
  84  *
  85  * @param chip_id Chip to return info for
  86  * @return Number of regions
  87  */
  88 int cvmx_flash_get_num_regions(int chip_id);
  89
  90 /**
  91  * Return information about a flash chips region
  92  *
  93  * @param chip_id Chip to get info for
  94  * @param region  Region to get info for
  95  * @return Region information
  96  */
  97 const cvmx_flash_region_t *cvmx_flash_get_region_info(int chip_id, int region);
  98
  99 /**
 100  * Erase a block on the flash chip
 101  *
 102  * @param chip_id Chip to erase a block on
 103  * @param region  Region to erase a block in
 104  * @param block   Block number to erase
 105  * @return Zero on success. Negative on failure
 106  */
 107 int cvmx_flash_erase_block(int chip_id, int region, int block);
 108
 109 /**
 110  * Write a block on the flash chip
 111  *
 112  * @param chip_id Chip to write a block on
 113  * @param region  Region to write a block in
 114  * @param block   Block number to write
 115  * @param data    Data to write
 116  * @return Zero on success. Negative on failure
 117  */
 118 int cvmx_flash_write_block(int chip_id, int region, int block, const void *data);
 119
 120 /**
 121  * Erase and write data to a flash
 122  *
 123  * @param address Memory address to write to
 124  * @param data    Data to write
 125  * @param len     Length of the data
 126  * @return Zero on success. Negative on failure
 127  */
 128 int cvmx_flash_write(void *address, const void *data, int len);
 129
 130 #ifdef  __cplusplus
 131 }
 132 #endif
 133
 134 #endif /* __CVMX_FLASH_H__ */