OLD | NEW |
(Empty) | |
| 1 /* |
| 2 * Copyright (c) 2008-2009 NVIDIA Corporation. |
| 3 * All rights reserved. |
| 4 * |
| 5 * Redistribution and use in source and binary forms, with or without |
| 6 * modification, are permitted provided that the following conditions are met: |
| 7 * |
| 8 * Redistributions of source code must retain the above copyright notice, |
| 9 * this list of conditions and the following disclaimer. |
| 10 * |
| 11 * Redistributions in binary form must reproduce the above copyright notice, |
| 12 * this list of conditions and the following disclaimer in the documentation |
| 13 * and/or other materials provided with the distribution. |
| 14 * |
| 15 * Neither the name of the NVIDIA Corporation nor the names of its contributors |
| 16 * may be used to endorse or promote products derived from this software |
| 17 * without specific prior written permission. |
| 18 * |
| 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| 23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 29 * POSSIBILITY OF SUCH DAMAGE. |
| 30 * |
| 31 */ |
| 32 |
| 33 /** |
| 34 * @file |
| 35 * <b>NVIDIA Tegra ODM Kit: |
| 36 * Pin Attributes Query Interface</b> |
| 37 * |
| 38 * @b Description: Provides a mechanism for ODMs to specify electrical |
| 39 * attributes, such as drive strength, for pins. |
| 40 */ |
| 41 |
| 42 #ifndef INCLUDED_NVODM_QUERY_PINS_H |
| 43 #define INCLUDED_NVODM_QUERY_PINS_H |
| 44 |
| 45 /** |
| 46 * @defgroup nvodm_pins Pin Electrical Attributes Query Interface |
| 47 * This is the ODM query interface for pin electrical attributes. |
| 48 * |
| 49 * Pin attribute settings match the hardware register definitions very |
| 50 * closely, and as such are specified in a chip-specific format. C-language |
| 51 * pre-processor macros are provided to allow for as much code readability |
| 52 * and maintainability as possible. Because the organization and the |
| 53 * electrical fine-tuning capabilities of the pins may change between |
| 54 * products, ODMs should ensure that they are using the macros that match |
| 55 * the SOC in their product. |
| 56 * @ingroup nvodm_query |
| 57 * @{ |
| 58 */ |
| 59 |
| 60 #include "nvcommon.h" |
| 61 |
| 62 #if defined(__cplusplus) |
| 63 extern "C" |
| 64 { |
| 65 #endif |
| 66 |
| 67 |
| 68 /** |
| 69 * Defines the pin attributes record. |
| 70 */ |
| 71 typedef struct NvOdmPinAttribRec |
| 72 { |
| 73 /// Specifies the configuration register to assign, which should be |
| 74 /// one of the application processor's NvOdmPinRegister enumerants. |
| 75 NvU32 ConfigRegister; |
| 76 |
| 77 /// Specifies the value to assign to the specified configuration register. |
| 78 /// Each application processor's header file provides pre-processor |
| 79 /// macros to assist in defining this value. |
| 80 NvU32 Value; |
| 81 } NvOdmPinAttrib; |
| 82 |
| 83 /** |
| 84 * Gets a list of [configuration register, value] pairs that are applied |
| 85 * to the application processor's pin configuration registers. Any |
| 86 * pin configuration register that is not specified in this list is left at |
| 87 * its current state. |
| 88 * |
| 89 * @param pPinAttributes A returned pointer to an array of constant pin |
| 90 * configuration attributes, or NULL if no pin configuration registers |
| 91 * should be programmed. |
| 92 * |
| 93 * @return The number of pin configuration attributes in \a pPinAttributes, or |
| 94 * 0 if none. |
| 95 */ |
| 96 |
| 97 NvU32 |
| 98 NvOdmQueryPinAttributes(const NvOdmPinAttrib **pPinAttributes); |
| 99 |
| 100 #if defined(__cplusplus) |
| 101 } |
| 102 #endif |
| 103 |
| 104 /** @} */ |
| 105 #endif |
| 106 |
OLD | NEW |