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

   1 /***********************license start***************
   2  * Copyright (c) 2003-2010  Cavium Inc. (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 Inc. 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  * This Software, including technical data, may be subject to U.S. export  control
  24  * laws, including the U.S. Export Administration Act and its  associated
  25  * regulations, and may be subject to export or import  regulations in other
  26  * countries.
  27
  28  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
  29  * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
  30  * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
  31  * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
  32  * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
  33  * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
  34  * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
  35  * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
  36  * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK ARISING OUT OF USE OR
  37  * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
  38  ***********************license end**************************************/
  39
  40
  41
  42
  43 #ifndef __CVMX_COMPACTFLASH_H__
  44 #define __CVMX_COMPACTFLASH_H__
  45 #ifdef  __cplusplus
  46 extern "C" {
  47 #endif
  48
  49
  50 /**
  51  * This function takes values from the compact flash device
  52  * identify response, and returns the appropriate value to write
  53  * into the boot bus DMA timing register.
  54  *
  55  * @param tim_mult   Eclock timing multiple to use
  56  * @param ident_data Data returned by the 'identify' command.  This is used to
  57  *                   determine the DMA modes supported by the card, if any.
  58  * @param mwdma_mode_ptr
  59  *                   Optional pointer to return MWDMA mode in
  60  *
  61  * @return 64 bit value to write to DMA timing register
  62  */
  63 extern uint64_t cvmx_compactflash_generate_dma_tim(int tim_mult, uint16_t *ident_data, int *mwdma_mode_ptr);
  64
  65 /**
  66  * Setup timing and region config to support a specific IDE PIO
  67  * mode over the bootbus.
  68  *
  69  * @param cs0      Bootbus region number connected to CS0 on the IDE device
  70  * @param cs1      Bootbus region number connected to CS1 on the IDE device
  71  * @param pio_mode PIO mode to set (0-6)
  72  */
  73 extern void cvmx_compactflash_set_piomode(int cs0, int cs1, int pio_mode);
  74
  75 #ifdef  __cplusplus
  76 }
  77 #endif
  78 #endif   /* __CVMX_COMPACTFLASH_H__ */