ST Americas mbed Team / NUCLEO-NFC01A1

NUCLEO-NFC01A1 board drivers.

Dependents:   Nucleo_NFC_Example I2C_NFC_Master Print_Entire_Nucleo_NFC01A1_Memory

Fork of X-NUCLEO-NFC01A1 by Enrico Gregoratto

Embed: (wiki syntax)

« Back to documentation index

drv_I2C_M24SR_mbed.cpp File Reference
Functions

drv_I2C_M24SR_mbed.cpp File Reference

This file provides a set of functions needed to manage the I2C of the M24SR device. More...

Go to the source code of this file.

Functions

void M24SR_I2CInit (void)
 This function initializes the M24SR_I2C interface.
void M24SR_SetI2CSynchroMode (uint8_t mode)
 this functions configure I2C synchronization mode
int8_t M24SR_PollI2C (void)
 This functions polls the I2C interface.
int8_t M24SR_ReceiveI2Cresponse (uint8_t NbByte, uint8_t *pBuffer)
 This functions reads a response of the M24SR device.
int8_t M24SR_SendI2Ccommand (uint8_t NbByte, uint8_t *pBuffer)
 This functions sends the command buffer.
int8_t M24SR_IsAnswerReady (void)
 This functions returns M24SR_STATUS_SUCCESS when a response is ready.
void M24SR_RFConfig_Hard (uint8_t OnOffChoice)
 This function enable or disable RF communication.

Detailed Description

This file provides a set of functions needed to manage the I2C of the M24SR device.

Author:
MMY Application Team
Version:
V1.0.0
Date:
19-March-2014
Attention:

© COPYRIGHT 2014 STMicroelectronics

Licensed under MMY-ST Liberty SW License Agreement V2, (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.st.com/software_license_agreement_liberty_v2

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file drv_I2C_M24SR_mbed.cpp.

Function Documentation

void M24SR_I2CInit ( void   )

This function initializes the M24SR_I2C interface.

Return values:
None

Definition at line 60 of file drv_I2C_M24SR_mbed.cpp.

int8_t M24SR_IsAnswerReady ( void   )

This functions returns M24SR_STATUS_SUCCESS when a response is ready.

Return values:
M24SR_STATUS_SUCCESS: a response of the M24LR is ready
M24SR_ERROR_DEFAULT: the response of the M24LR is not ready

Definition at line 148 of file drv_I2C_M24SR_mbed.cpp.

int8_t M24SR_PollI2C ( void   )

This functions polls the I2C interface.

Return values:
M24SR_STATUS_SUCCESS: the function is succesful
M24SR_ERROR_I2CTIMEOUT: The I2C timeout occured.

Definition at line 89 of file drv_I2C_M24SR_mbed.cpp.

int8_t M24SR_ReceiveI2Cresponse ( uint8_t  NbByte,
uint8_t *  pBuffer 
)

This functions reads a response of the M24SR device.

Parameters:
NbByte: Number of byte to read (shall be >= 5)
pBuffer: Pointer to the buffer to send to the M24SR
Return values:
M24SR_STATUS_SUCCESS: The function is succesful
M24SR_ERROR_I2CTIMEOUT: The I2C timeout occured.

Definition at line 116 of file drv_I2C_M24SR_mbed.cpp.

void M24SR_RFConfig_Hard ( uint8_t  OnOffChoice )

This function enable or disable RF communication.

Parameters:
OnOffChoice,:GPO configuration to set

Definition at line 192 of file drv_I2C_M24SR_mbed.cpp.

int8_t M24SR_SendI2Ccommand ( uint8_t  NbByte,
uint8_t *  pBuffer 
)

This functions sends the command buffer.

Parameters:
NbByte: Number of byte to send
pBuffer: pointer to the buffer to send to the M24SR
Return values:
M24SR_STATUS_SUCCESS: the function is succesful
M24SR_ERROR_I2CTIMEOUT: The I2C timeout occured.

Definition at line 131 of file drv_I2C_M24SR_mbed.cpp.

void M24SR_SetI2CSynchroMode ( uint8_t  mode )

this functions configure I2C synchronization mode

Parameters:
mode:
Return values:
None

Definition at line 72 of file drv_I2C_M24SR_mbed.cpp.

Generated on Sat Jul 16 2022 11:22:31 by  doxygen 1.7.2