1 /******************************************************************************
3 * Copyright (C) 2002 - 2014 Xilinx, Inc. All rights reserved.
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * Use of the Software is limited solely to applications:
16 * (a) running on a Xilinx device, or
17 * (b) that interact with a Xilinx device through a bus or interconnect.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * XILINX BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
24 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * Except as contained in this notice, the name of the Xilinx shall not be used
28 * in advertising or otherwise to promote the sale, use or other dealings in
29 * this Software without prior written authorization from Xilinx.
31 ******************************************************************************/
32 /*****************************************************************************/
36 * The implementation of the XGpio driver's advanced discrete functions.
37 * See xgpio.h for more information about the driver.
41 * These APIs can only be used if the GPIO_IO ports in the IP are used for
42 * connecting to the external output ports.
46 * MODIFICATION HISTORY:
48 * Ver Who Date Changes
49 * ----- ---- -------- -----------------------------------------------
50 * 1.00a rmm 02/04/02 First release
51 * 2.00a jhl 12/16/02 Update for dual channel and interrupt support
52 * 2.11a mta 03/21/07 Updated to new coding style
53 * 3.00a sv 11/21/09 Updated to use HAL Processor APIs. Renamed the macros
54 * XGpio_mWriteReg to XGpio_WriteReg, and XGpio_mReadReg
58 *****************************************************************************/
60 /***************************** Include Files ********************************/
65 /************************** Constant Definitions ****************************/
67 /**************************** Type Definitions ******************************/
69 /***************** Macros (Inline Functions) Definitions ********************/
71 /************************** Variable Definitions ****************************/
73 /************************** Function Prototypes *****************************/
76 /****************************************************************************/
78 * Set output discrete(s) to logic 1 for the specified GPIO channel.
80 * @param InstancePtr is a pointer to an XGpio instance to be worked on.
81 * @param Channel contains the channel of the GPIO (1 or 2) to operate on.
82 * @param Mask is the set of bits that will be set to 1 in the discrete
83 * data register. All other bits in the data register are
90 * The hardware must be built for dual channels if this function is used
91 * with any channel other than 1. If it is not, this function will assert.
93 * This API can only be used if the GPIO_IO ports in the IP are used for
94 * connecting to the external output ports.
96 *****************************************************************************/
97 void XGpio_DiscreteSet(XGpio * InstancePtr, unsigned Channel, u32 Mask)
102 Xil_AssertVoid(InstancePtr != NULL);
103 Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
104 Xil_AssertVoid((Channel == 1) ||
105 ((Channel == 2) && (InstancePtr->IsDual == TRUE)));
108 * Calculate the offset to the data register of the GPIO once
110 DataOffset = ((Channel - 1) * XGPIO_CHAN_OFFSET) + XGPIO_DATA_OFFSET;
113 * Read the contents of the data register, merge in Mask and write
116 Current = XGpio_ReadReg(InstancePtr->BaseAddress, DataOffset);
118 XGpio_WriteReg(InstancePtr->BaseAddress, DataOffset, Current);
122 /****************************************************************************/
124 * Set output discrete(s) to logic 0 for the specified GPIO channel.
126 * @param InstancePtr is a pointer to an XGpio instance to be worked on.
127 * @param Channel contains the channel of the GPIO (1 or 2) to operate on.
128 * @param Mask is the set of bits that will be set to 0 in the discrete
129 * data register. All other bits in the data register are
136 * The hardware must be built for dual channels if this function is used
137 * with any channel other than 1. If it is not, this function will assert.
139 * This API can only be used if the GPIO_IO ports in the IP are used for
140 * connecting to the external output ports.
142 *****************************************************************************/
143 void XGpio_DiscreteClear(XGpio * InstancePtr, unsigned Channel, u32 Mask)
148 Xil_AssertVoid(InstancePtr != NULL);
149 Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
150 Xil_AssertVoid((Channel == 1) ||
151 ((Channel == 2) && (InstancePtr->IsDual == TRUE)));
154 * Calculate the offset to the data register of the GPIO once
156 DataOffset = ((Channel - 1) * XGPIO_CHAN_OFFSET) + XGPIO_DATA_OFFSET;
159 * Read the contents of the data register, merge in Mask and write
162 Current = XGpio_ReadReg(InstancePtr->BaseAddress, DataOffset);
164 XGpio_WriteReg(InstancePtr->BaseAddress, DataOffset, Current);