no-OS
Functions | Variables
ltc4332.h File Reference

Header file of SPI ltc4332 Interface. More...

#include "no_os_spi.h"
Include dependency graph for ltc4332.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

int32_t ltc4332_spi_init (struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
 Initialize the SPI ltc4332 layer. More...
 
int32_t ltc4332_spi_remove (struct no_os_spi_desc *desc)
 Free the resources allocated by ltc4332_spi_init(). More...
 
int32_t ltc4332_spi_write_and_read (struct no_os_spi_desc *desc, uint8_t *data, uint16_t bytes_number)
 Write and read data to/from SPI ltc4332 layer. More...
 

Variables

const struct no_os_spi_platform_ops ltc4332_spi_platform_ops
 LTC4332 specific SPI platform ops structure. More...
 

Detailed Description

Header file of SPI ltc4332 Interface.

Author
Paul Benoit (paul..nosp@m.beno.nosp@m.it@an.nosp@m.alog.nosp@m..com)

Copyright 2022(c) Analog Devices, Inc.

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

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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.
  3. 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.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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.

Function Documentation

◆ ltc4332_spi_init()

int32_t ltc4332_spi_init ( struct no_os_spi_desc **  desc,
const struct no_os_spi_init_param param 
)

Initialize the SPI ltc4332 layer.

Parameters
desc- The SPI descriptor.
param- The structure that contains the SPI parameters.
Returns
0 in case of success, -1 otherwise.

◆ ltc4332_spi_remove()

int32_t ltc4332_spi_remove ( struct no_os_spi_desc desc)

Free the resources allocated by ltc4332_spi_init().

Parameters
desc- The SPI descriptor.
Returns
0 in case of success, -1 otherwise.

◆ ltc4332_spi_write_and_read()

int32_t ltc4332_spi_write_and_read ( struct no_os_spi_desc desc,
uint8_t *  data,
uint16_t  bytes_number 
)

Write and read data to/from SPI ltc4332 layer.

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

Variable Documentation

◆ ltc4332_spi_platform_ops

const struct no_os_spi_platform_ops ltc4332_spi_platform_ops

LTC4332 specific SPI platform ops structure.