| 1 | /******************************************************************************* |
| 2 | Copyright (C) Marvell International Ltd. and its affiliates |
| 3 | |
| 4 | This software file (the "File") is owned and distributed by Marvell |
| 5 | International Ltd. and/or its affiliates ("Marvell") under the following |
| 6 | alternative licensing terms. Once you have made an election to distribute the |
| 7 | File under one of the following license alternatives, please (i) delete this |
| 8 | introductory statement regarding license alternatives, (ii) delete the two |
| 9 | license alternatives that you have not elected to use and (iii) preserve the |
| 10 | Marvell copyright notice above. |
| 11 | |
| 12 | ******************************************************************************** |
| 13 | Marvell Commercial License Option |
| 14 | |
| 15 | If you received this File from Marvell and you have entered into a commercial |
| 16 | license agreement (a "Commercial License") with Marvell, the File is licensed |
| 17 | to you under the terms of the applicable Commercial License. |
| 18 | |
| 19 | ******************************************************************************** |
| 20 | Marvell GPL License Option |
| 21 | |
| 22 | If you received this File from Marvell, you may opt to use, redistribute and/or |
| 23 | modify this File in accordance with the terms and conditions of the General |
| 24 | Public License Version 2, June 1991 (the "GPL License"), a copy of which is |
| 25 | available along with the File in the license.txt file or by writing to the Free |
| 26 | Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 or |
| 27 | on the worldwide web at http://www.gnu.org/licenses/gpl.txt. |
| 28 | |
| 29 | THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED |
| 30 | WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY |
| 31 | DISCLAIMED. The GPL License provides additional details about this warranty |
| 32 | disclaimer. |
| 33 | ******************************************************************************** |
| 34 | Marvell BSD License Option |
| 35 | |
| 36 | If you received this File from Marvell, you may opt to use, redistribute and/or |
| 37 | modify this File under the following licensing terms. |
| 38 | Redistribution and use in source and binary forms, with or without modification, |
| 39 | are permitted provided that the following conditions are met: |
| 40 | |
| 41 | * Redistributions of source code must retain the above copyright notice, |
| 42 | this list of conditions and the following disclaimer. |
| 43 | |
| 44 | * Redistributions in binary form must reproduce the above copyright |
| 45 | notice, this list of conditions and the following disclaimer in the |
| 46 | documentation and/or other materials provided with the distribution. |
| 47 | |
| 48 | * Neither the name of Marvell nor the names of its contributors may be |
| 49 | used to endorse or promote products derived from this software without |
| 50 | specific prior written permission. |
| 51 | |
| 52 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
| 53 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| 54 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 55 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR |
| 56 | ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| 57 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| 58 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
| 59 | ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 60 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| 61 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 62 | |
| 63 | *******************************************************************************/ |
| 64 | #ifndef __INCmvTwsiH |
| 65 | #define __INCmvTwsiH |
| 66 | |
| 67 | #ifdef __cplusplus |
| 68 | extern "C" { |
| 69 | #endif /* __cplusplus */ |
| 70 | |
| 71 | /* need to update this includes */ |
| 72 | #include "twsi/mvTwsiSpec.h" |
| 73 | #include "ctrlEnv/mvCtrlEnvLib.h" |
| 74 | |
| 75 | |
| 76 | /* The TWSI interface supports both 7-bit and 10-bit addressing. */ |
| 77 | /* This enumerator describes addressing type. */ |
| 78 | typedef enum _mvTwsiAddrType |
| 79 | { |
| 80 | ADDR7_BIT, /* 7 bit address */ |
| 81 | ADDR10_BIT /* 10 bit address */ |
| 82 | }MV_TWSI_ADDR_TYPE; |
| 83 | |
| 84 | /* This structure describes TWSI address. */ |
| 85 | typedef struct _mvTwsiAddr |
| 86 | { |
| 87 | MV_U32 address; /* address */ |
| 88 | MV_TWSI_ADDR_TYPE type; /* Address type */ |
| 89 | }MV_TWSI_ADDR; |
| 90 | |
| 91 | /* This structure describes a TWSI slave. */ |
| 92 | typedef struct _mvTwsiSlave |
| 93 | { |
| 94 | MV_TWSI_ADDR slaveAddr; |
| 95 | MV_BOOL validOffset; /* whether the slave has offset (i.e. Eeprom etc.) */ |
| 96 | MV_U32 offset; /* offset in the slave. */ |
| 97 | MV_BOOL moreThen256; /* whether the ofset is bigger then 256 */ |
| 98 | }MV_TWSI_SLAVE; |
| 99 | |
| 100 | /* This enumerator describes TWSI protocol commands. */ |
| 101 | typedef enum _mvTwsiCmd |
| 102 | { |
| 103 | MV_TWSI_WRITE, /* TWSI write command - 0 according to spec */ |
| 104 | MV_TWSI_READ /* TWSI read command - 1 according to spec */ |
| 105 | }MV_TWSI_CMD; |
| 106 | |
| 107 | MV_STATUS mvTwsiStartBitSet(MV_U8 chanNum); |
| 108 | MV_STATUS mvTwsiStopBitSet(MV_U8 chanNum); |
| 109 | MV_STATUS mvTwsiAddrSet(MV_U8 chanNum, MV_TWSI_ADDR *twsiAddr, MV_TWSI_CMD command); |
| 110 | |
| 111 | MV_U32 mvTwsiInit(MV_U8 chanNum, MV_KHZ frequancy, MV_U32 Tclk, MV_TWSI_ADDR *twsiAddr, MV_BOOL generalCallEnable); |
| 112 | MV_STATUS mvTwsiRead (MV_U8 chanNum, MV_TWSI_SLAVE *twsiSlave, MV_U8 *pBlock, MV_U32 blockSize); |
| 113 | MV_STATUS mvTwsiWrite(MV_U8 chanNum, MV_TWSI_SLAVE *twsiSlave, MV_U8 *pBlock, MV_U32 blockSize); |
| 114 | |
| 115 | |
| 116 | #ifdef __cplusplus |
| 117 | } |
| 118 | #endif /* __cplusplus */ |
| 119 | |
| 120 | #endif /* __INCmvTwsiH */ |
| 121 | |
| 122 | |
