Sean Smith / platform_drivers

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

platform_drivers.cpp File Reference
Functions | Variables

platform_drivers.cpp File Reference

Implementation of Generic Platform Drivers. More...

Go to the source code of this file.

Functions

int32_t mbed_i2c_init (struct i2c_desc **desc, const struct i2c_init_param *param)
 Initialize the I2C communication peripheral.
int32_t i2c_remove (struct i2c_desc *desc)
 Free the resources allocated by i2c_init().
int32_t mbed_i2c_write (struct i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
 Write data to a slave device.
int32_t mbed_i2c_read (struct i2c_desc *desc, uint8_t *data, uint8_t bytes_number, uint8_t stop_bit)
 Read data from a slave device.
int32_t mbed_spi_init (struct spi_desc **desc, const struct spi_init_param *param)
 Initialize the SPI communication peripheral.
int32_t spi_remove (struct spi_desc *desc)
 Free the resources allocated by spi_init().
int32_t spi_write_and_read (struct spi_desc *desc, uint8_t *data, uint8_t bytes_number)
 Write and read data to/from SPI.
int32_t gpio_get (struct gpio_desc **desc, gpio_desc init_values)
 Obtain the GPIO decriptor.
int32_t gpio_remove (struct gpio_desc *desc)
 Free the resources allocated by gpio_get().
int32_t gpio_direction_input (struct gpio_desc *desc)
 Enable the input direction of the specified GPIO.
int32_t gpio_direction_output (struct gpio_desc *desc, uint8_t value)
 Enable the output direction of the specified GPIO.
int32_t gpio_get_direction (struct gpio_desc *desc, uint8_t *direction)
 Get the direction of the specified GPIO.
int32_t gpio_set_value (struct gpio_desc *desc, uint8_t value)
 Set the value of the specified GPIO.
int32_t gpio_get_value (struct gpio_desc *desc, uint8_t *value)
 Get the value of the specified GPIO.
void mdelay (uint32_t msecs)
 Generate miliseconds delay.

Variables

SPI spi
 Provide implementations for the following extern functions.

Detailed Description

Implementation of Generic Platform Drivers.

Author:
DBogdan (dragos.bogdan@analog.com)

Copyright 2017,2019(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
  • The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
  • Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file platform_drivers.cpp.

Function Documentation

int32_t gpio_direction_input ( struct gpio_desc *  desc )

Enable the input direction of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 266 of file platform_drivers.cpp.

int32_t gpio_direction_output ( struct gpio_desc *  desc,
uint8_t  value 
)

Enable the output direction of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
value- The value. Example: GPIO_HIGH GPIO_LOW
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 283 of file platform_drivers.cpp.

int32_t gpio_get ( struct gpio_desc **  desc,
gpio_desc  init_values 
)

Obtain the GPIO decriptor.

Parameters:
desc- The GPIO descriptor.
gpio_number- The number of the GPIO.
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 233 of file platform_drivers.cpp.

int32_t gpio_get_direction ( struct gpio_desc *  desc,
uint8_t *  direction 
)

Get the direction of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
direction- The direction. Example: GPIO_OUT GPIO_IN
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 301 of file platform_drivers.cpp.

int32_t gpio_get_value ( struct gpio_desc *  desc,
uint8_t *  value 
)

Get the value of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
value- The value. Example: GPIO_HIGH GPIO_LOW
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 342 of file platform_drivers.cpp.

int32_t gpio_remove ( struct gpio_desc *  desc )

Free the resources allocated by gpio_get().

Parameters:
desc- The SPI descriptor.
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 252 of file platform_drivers.cpp.

int32_t gpio_set_value ( struct gpio_desc *  desc,
uint8_t  value 
)

Set the value of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
value- The value. Example: GPIO_HIGH GPIO_LOW
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 323 of file platform_drivers.cpp.

int32_t i2c_remove ( struct i2c_desc *  desc )

Free the resources allocated by i2c_init().

Parameters:
desc- The I2C descriptor.
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 87 of file platform_drivers.cpp.

int32_t mbed_i2c_init ( struct i2c_desc **  desc,
const struct i2c_init_param *  param 
)

Initialize the I2C communication peripheral.

Parameters:
desc- The I2C descriptor.
param- The structure that contains the I2C parameters.
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 68 of file platform_drivers.cpp.

int32_t mbed_i2c_read ( struct i2c_desc *  desc,
uint8_t *  data,
uint8_t  bytes_number,
uint8_t  stop_bit 
)

Read data from a slave device.

Parameters:
desc- The I2C descriptor.
data- Buffer that will store the received data.
bytes_number- Number of bytes to read.
stop_bit- Stop condition control. Example: 0 - A stop condition will not be generated; 1 - A stop condition will be generated.
Returns:
SUCCESS in case of success, FAILURE otherwise.

The MBED I2C API is reversed for parameter 4 Instead of stop_bit - it has

Parameters:
repeated- Repeated start, true - don't send stop at end default value is false. Inverting here to keep the no-OS/platform_drivers API

Definition at line 134 of file platform_drivers.cpp.

int32_t mbed_i2c_write ( struct i2c_desc *  desc,
uint8_t *  data,
uint8_t  bytes_number,
uint8_t  stop_bit 
)

Write data to a slave device.

Parameters:
desc- The I2C descriptor.
data- Buffer that stores the transmission data.
bytes_number- Number of bytes to write.
stop_bit- Stop condition control. Example: 0 - A stop condition will not be generated; 1 - A stop condition will be generated.
Returns:
SUCCESS in case of success, FAILURE otherwise.

The MBED I2C API is reversed for parameter 4 Instead of stop_bit - it has

Parameters:
repeated- Repeated start, true - don't send stop at end default value is false. Inverting here to keep the no-OS/platform_drivers API

Definition at line 107 of file platform_drivers.cpp.

int32_t mbed_spi_init ( struct spi_desc **  desc,
const struct spi_init_param *  param 
)

Initialize the SPI communication peripheral.

Parameters:
desc- The SPI descriptor.
init_param- The structure that contains the SPI parameters.
Returns:
SUCCESS in case of success, FAILURE otherwise.

NOTE: Actual frequency of SPI clk will be somewhat device dependent, relating to clock-settings, prescalars etc. If absolute SPI frequency is required, consult your device documentation.

Definition at line 157 of file platform_drivers.cpp.

void mdelay ( uint32_t  msecs )

Generate miliseconds delay.

Parameters:
msecs- Delay in miliseconds.
Returns:
None.

Definition at line 363 of file platform_drivers.cpp.

int32_t spi_remove ( struct spi_desc *  desc )

Free the resources allocated by spi_init().

Parameters:
desc- The SPI descriptor.
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 187 of file platform_drivers.cpp.

int32_t spi_write_and_read ( struct spi_desc *  desc,
uint8_t *  data,
uint8_t  bytes_number 
)

Write and read data to/from SPI.

This function will be updated to improve performance

Parameters:
desc- The SPI descriptor.
data- The buffer with the transmitted/received data.
bytes_number- Number of bytes to write/read.
Returns:
SUCCESS in case of success, FAILURE otherwise.

select SS

deselect SS

Definition at line 207 of file platform_drivers.cpp.

Variable Documentation

SPI spi

Provide implementations for the following extern functions.

For Example - in main.cpp PinName slave_selects[8] = { SPI_CS, SPI_CSE }; mbed::SPI spi(SPI_MOSI, SPI_MISO, SPI_SCK); mbed::I2C i2c(I2C_SDA, I2C_SCL);

Generated on Thu Jul 28 2022 08:31:43 by  doxygen 1.7.2