sys/contrib/octeon-sdk/cvmx-gpio.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  * General Purpose IO interface.
  48  *
  49  * <hr>$Revision: 41586 $<hr>
  50  */
  51
  52 #ifndef __CVMX_GPIO_H__
  53 #define __CVMX_GPIO_H__
  54
  55 #ifdef  __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 /* CSR typedefs have been moved to cvmx-csr-*.h */
  60
  61 /**
  62  * Clear the interrupt rising edge detector for the supplied
  63  * pins in the mask. Chips which have more than 16 GPIO pins
  64  * can't use them for interrupts.
  65  *
  66  * @param clear_mask Mask of pins to clear
  67  */
  68 static inline void cvmx_gpio_interrupt_clear(uint16_t clear_mask)
  69 {
  70     cvmx_gpio_int_clr_t gpio_int_clr;
  71     gpio_int_clr.u64 = 0;
  72     gpio_int_clr.s.type = clear_mask;
  73     cvmx_write_csr(CVMX_GPIO_INT_CLR, gpio_int_clr.u64);
  74 }
  75
  76
  77 /**
  78  * GPIO Read Data
  79  *
  80  * @return Status of the GPIO pins
  81  */
  82 static inline uint32_t cvmx_gpio_read(void)
  83 {
  84     cvmx_gpio_rx_dat_t gpio_rx_dat;
  85     gpio_rx_dat.u64 = cvmx_read_csr(CVMX_GPIO_RX_DAT);
  86     return gpio_rx_dat.s.dat;
  87 }
  88
  89
  90 /**
  91  * GPIO Clear pin
  92  *
  93  * @param clear_mask Bit mask to indicate which bits to drive to '0'.
  94  */
  95 static inline void cvmx_gpio_clear(uint32_t clear_mask)
  96 {
  97     cvmx_gpio_tx_clr_t gpio_tx_clr;
  98     gpio_tx_clr.u64 = 0;
  99     gpio_tx_clr.s.clr = clear_mask;
 100     cvmx_write_csr(CVMX_GPIO_TX_CLR, gpio_tx_clr.u64);
 101 }
 102
 103
 104 /**
 105  * GPIO Set pin
 106  *
 107  * @param set_mask Bit mask to indicate which bits to drive to '1'.
 108  */
 109 static inline void cvmx_gpio_set(uint32_t set_mask)
 110 {
 111     cvmx_gpio_tx_set_t gpio_tx_set;
 112     gpio_tx_set.u64 = 0;
 113     gpio_tx_set.s.set = set_mask;
 114     cvmx_write_csr(CVMX_GPIO_TX_SET, gpio_tx_set.u64);
 115 }
 116
 117 #ifdef  __cplusplus
 118 }
 119 #endif
 120
 121 #endif
 122