Embedded Application Programming Interface - picmg

More documents

Recommendations

Info

* | EAPI_STATUS_NOT_FOUND * startAckNak | EAPI_STATUS_WRITE_ERROR * startAckNak | EAPI_STATUS_WRITE_ERROR * ByteCnt>BufLen | EAPI_STATUS_MORE_DATA * Common Error | Common Error Code * Else | EAPI_STATUS_SUCCESS */ EApiStatus_t EAPI_CALLTYPE EApiI2CReadTransfer( __IN EApiId_t Id , /* I2C Bus Id */ __IN uint32_t Addr , /* Encoded 7/10Bit I2C * Device Address */ __IN uint32_t Cmd , /* I2C Command/Offset */ __OUT void *pBuffer , /* Transfer Data pBuffer */ __IN uint32_t BufLen , /* Data pBuffer Length */ __IN uint32_t ByteCnt /* Byte Count to read */ ); /* * EApiI2CWriteTransfer * Addr Byte 1 Below Designates Addr MSB in a 10bit address transfer and * the complete address in an 7bit address transfer. * * Condition | Return Values * ---------------------------------------+------------------------------ * Library Uninitialized | EAPI_STATUS_NOT_INITIALIZED * pBuffer==NULL | EAPI_STATUS_INVALID_PARAMETER * ByteCnt==0 | EAPI_STATUS_INVALID_PARAMETER * unknown Id | EAPI_STATUS_UNSUPPORTED * ByteCnt+(overhead)>pMaxBlkLen | EAPI_STATUS_INVALID_BLOCK_LENGTH * Bus Busy SDA/SDC low | EAPI_STATUS_BUSY_COLLISION * Arbitration Error/Collision Error | EAPI_STATUS_BUSY_COLLISION * On Write 1 write cycle | * SDA Remains low | * Time-out due to clock stretching | EAPI_STATUS_TIMEOUT * startNak | EAPI_STATUS_NOT_FOUND * startNak | EAPI_STATUS_NOT_FOUND * startAckNak | EAPI_STATUS_WRITE_ERROR or * | EAPI_STATUS_NOT_FOUND * startAckNak | EAPI_STATUS_WRITE_ERROR * startAckNak | EAPI_STATUS_WRITE_ERROR * Common Error | Common Error Code * Else | EAPI_STATUS_SUCCESS */ EApiStatus_t EAPI_CALLTYPE EApiI2CWriteTransfer( __IN EApiId_t Id , /* I2C Bus Id */ __IN uint32_t Addr , /* Encoded 7/10Bit I2C * Device Address */ __IN uint32_t Cmd , /* I2C Command/Offset */ __IN void *pBuffer , /* Transfer Data pBuffer */ __IN uint32_t ByteCnt /* Byte Count to write */ ); /* * I2C Probe Types * * Probe Type 1: * Address Format : 7Bit * StartAck Stop * * Probe Type 2: * Address Format : 10Bit * StartAckAck Stop * */ /* * EApiI2CProbeDevice * * Condition | Return Values * ---------------------------------------------+------------------------------ * Library Uninitialized | EAPI_STATUS_NOT_INITIALIZED * Bus Busy SDA/SDC low | EAPI_STATUS_BUSY_COLLISION PICMG® EAPI R1.0, August 8, 2010 page 66 of 83
* Arbitration Error/Collision Error | EAPI_STATUS_BUSY_COLLISION * On Write 1 write cycle | * SDA Remains low | * Time-out due to clock stretching | EAPI_STATUS_TIMEOUT * | * 7Bit Address | * startNak | EAPI_STATUS_NOT_FOUND * | * 10Bit Address | * startNak | EAPI_STATUS_NOT_FOUND * startAckNak | EAPI_STATUS_NOT_FOUND * | * Common Error | Common Error Code * Else | EAPI_STATUS_SUCCESS */ EApiStatus_t EAPI_CALLTYPE EApiI2CProbeDevice( __IN EApiId_t Id , /* I2C Bus Id */ __IN uint32_t Addr /* Encoded 7/10Bit * I2C Device Address */ ); /* * * W A T C H D O G * */ /* * * After EApiWDogStart * * |||| * A-----------B-------------------C-------------------D * * * After EApiWDogTrigger * * ||| * E-------------------F-------------------G * * * Stage A * Watchdog is started. * * Stage B * Initial Delay Period is exhausted. * * Stage C/F * Event is triggered, NMI, IRQ, or PIN is Triggered. * To Allow for possible Software Recovery. * * Stage D/G * System is reset. * * Stage E * Watchdog is Triggered. * * EApiWDogTrigger/EApiWDogStop Must be called before Stage C/F * to prevent event from being generated. * * EApiWDogTrigger/EApiWDogStop Must be called before Stage D/G * to prevent The system from being reset. * */ /* * EApiWDogGetCap * * Condition | Return Values * ---------------------------------------+------------------------------ * Library Uninitialized | EAPI_STATUS_NOT_INITIALIZED * Unsupported | EAPI_STATUS_UNSUPPORTED * pMaxDelay==NULL&& | * pMaxResetTimeout==NULL&& | PICMG® EAPI R1.0, August 8, 2010 page 67 of 83
Page 1 and 2:
EAPI PICMG EAPI Revision 1.0 August
Page 3 and 4:
10.1 EApi.h .......................
Page 5 and 6:
Revision History Revision Date Acti
Page 7 and 8:
1.2 Intellectual Property The Conso
Page 9 and 10:
1.5 Special Word Usage Mandatory fe
Page 11 and 12:
Term PE PE/COFF PEG PHY PNP PNPID P
Page 13 and 14:
1.7 Applicable Documents and Standa
Page 15 and 16: 2 General COM Express specifi
Page 17 and 18: EAPI_STATUS_INITIALIZED Description
Page 19 and 20: EAPI_STATUS_WRITE_ERROR Description
Page 21 and 22: 4 EAPI Information Functions 4.1 EA
Page 23 and 24: Id Description Units/Format EAPI_ID
Page 25 and 26: 5.2.1 Description Returns current B
Page 27 and 28: 5.5.1 Description Sets the brightne
Page 29 and 30: 6.2.3 Return Status Codes Condition
Page 33 and 34: 7.2 Address Format for the I2C Bus
Page 35 and 36: Transfer Type 10: Address Format :
Page 37 and 38: 7.6.1 Description Universal functio
Page 39 and 40: 7.7.2 Parameters Id __IN See '7.1.1
Page 43 and 44: 8 WATCHDOG After the watchdog timer
Page 45 and 46: 8.2.1 Description Start the watchdo
Page 47 and 48: 9 GPIO Functions COM Express specif
Page 49 and 50: 9.2.1 Description Reads the capabil
Page 51 and 52: 9.4 EApiGPIOSetDirection 9.4.1 Desc
Page 53 and 54: 9.6 EApiGPIOSetLevel 9.6.1 Descript
Page 55 and 56: #ifndef __OUT # define __OUT /* __O
Page 57 and 58: * Use pInputs and pOutputs to corre
Page 59 and 60: ) #define EAPI_CREATE_PNPID(a, b, c
Page 61 and 62: * Condition | Return Values * -----
Page 63 and 64: */ /* IDs */ #define EAPI_ID_I2C_EX
Page 65: * StartAckNak Stop * * Transfer Typ
Page 69 and 70: * * G P I O * */ /* * * +----------
Page 71 and 72: #define EAPI_GPIO_BITMASK_SELECT 1
Page 73 and 74: 10.2 EApiCOM0.h /* * *+============
Page 75 and 76: #define EAPI_COM0_ID_GPIO_GPO3 EAPI
Page 77 and 78: 12 Standard Data Formats 12.1 Compr
Page 79 and 80: 13 OS Specific Requirements 13.1 Wi
Page 81 and 82: Variable Name SVersion LVersion Man
Page 83: 15 Revision History Revision Date N
show all

Embedded Application Programming Interface - picmg

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?