| 1 | /*************************************************************************** |
|---|
| 2 | * Copyright (c) 2004-2008, Broadcom Corporation |
|---|
| 3 | * All Rights Reserved |
|---|
| 4 | * Confidential Property of Broadcom Corporation |
|---|
| 5 | * |
|---|
| 6 | * THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE |
|---|
| 7 | * AGREEMENT BETWEEN THE USER AND BROADCOM. YOU HAVE NO RIGHT TO USE OR |
|---|
| 8 | * EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT. |
|---|
| 9 | * |
|---|
| 10 | * $brcm_Workfile: nexus_i2c_init.h $ |
|---|
| 11 | * $brcm_Revision: 1 $ |
|---|
| 12 | * $brcm_Date: 1/18/08 2:21p $ |
|---|
| 13 | * |
|---|
| 14 | * API Description: |
|---|
| 15 | * API name: I2c |
|---|
| 16 | * Specific APIs related to I2c Control. |
|---|
| 17 | * |
|---|
| 18 | * Revision History: |
|---|
| 19 | * |
|---|
| 20 | * $brcm_Log: /nexus/modules/i2c/7400/include/nexus_i2c_init.h $ |
|---|
| 21 | * |
|---|
| 22 | * 1 1/18/08 2:21p jgarrett |
|---|
| 23 | * PR 38808: Merging to main branch |
|---|
| 24 | * |
|---|
| 25 | * Nexus_Devel/2 11/29/07 2:24p erickson |
|---|
| 26 | * PR35457: doc update for 0.5 release |
|---|
| 27 | * |
|---|
| 28 | * Nexus_Devel/1 10/5/07 1:42p jgarrett |
|---|
| 29 | * PR 35744: Adding initial version |
|---|
| 30 | * |
|---|
| 31 | ***************************************************************************/ |
|---|
| 32 | #ifndef NEXUS_I2C_INIT_H__ |
|---|
| 33 | #define NEXUS_I2C_INIT_H__ |
|---|
| 34 | |
|---|
| 35 | #ifdef __cplusplus |
|---|
| 36 | extern "C" { |
|---|
| 37 | #endif |
|---|
| 38 | |
|---|
| 39 | /** |
|---|
| 40 | Summary: |
|---|
| 41 | Settings used to configure the I2c module. |
|---|
| 42 | |
|---|
| 43 | Description: |
|---|
| 44 | This modules has no settings currently. |
|---|
| 45 | |
|---|
| 46 | See Also: |
|---|
| 47 | NEXUS_I2cModule_GetDefaultSettings |
|---|
| 48 | NEXUS_I2cModule_Init |
|---|
| 49 | **/ |
|---|
| 50 | typedef void NEXUS_I2cModuleSettings; |
|---|
| 51 | |
|---|
| 52 | /** |
|---|
| 53 | Summary: |
|---|
| 54 | Get default settings for the structure. |
|---|
| 55 | |
|---|
| 56 | Description: |
|---|
| 57 | This is required in order to make application code resilient to the addition of new strucutre members in the future. |
|---|
| 58 | |
|---|
| 59 | See Also: |
|---|
| 60 | NEXUS_I2cModule_Init |
|---|
| 61 | **/ |
|---|
| 62 | void NEXUS_I2cModule_GetDefaultSettings( |
|---|
| 63 | NEXUS_I2cModuleSettings *pSettings /* [out] */ |
|---|
| 64 | ); |
|---|
| 65 | |
|---|
| 66 | /** |
|---|
| 67 | Summary: |
|---|
| 68 | Initialize the I2c module. |
|---|
| 69 | |
|---|
| 70 | Description: |
|---|
| 71 | This is called by the NEXUS Platform when the system is initialized. |
|---|
| 72 | |
|---|
| 73 | See Also: |
|---|
| 74 | NEXUS_I2cModule_Uninit |
|---|
| 75 | NEXUS_I2c_Open - open Interface for I2c |
|---|
| 76 | **/ |
|---|
| 77 | NEXUS_ModuleHandle NEXUS_I2cModule_Init( |
|---|
| 78 | const NEXUS_I2cModuleSettings *pSettings |
|---|
| 79 | ); |
|---|
| 80 | |
|---|
| 81 | /** |
|---|
| 82 | Summary: |
|---|
| 83 | Uninitialize the I2c module. |
|---|
| 84 | |
|---|
| 85 | Description: |
|---|
| 86 | This is called by the NEXUS Platform when the system is uninitialized. |
|---|
| 87 | |
|---|
| 88 | See Also: |
|---|
| 89 | NEXUS_I2cModule_Init |
|---|
| 90 | **/ |
|---|
| 91 | void NEXUS_I2cModule_Uninit(void); |
|---|
| 92 | |
|---|
| 93 | #ifdef __cplusplus |
|---|
| 94 | } |
|---|
| 95 | #endif |
|---|
| 96 | |
|---|
| 97 | #endif /* #ifndef NEXUS_I2C_H__ */ |
|---|
| 98 | |
|---|
| 99 | |
|---|
