generic_spi.c File Reference

#include "no_os_error.h"
#include "no_os_spi.h"
#include "no_os_util.h"

Include dependency graph for generic_spi.c:

Functions
int32_t	generic_spi_init (struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
	Initialize the SPI communication peripheral.
int32_t	generic_spi_remove (struct no_os_spi_desc *desc)
	Free the resources allocated by no_os_spi_init().
int32_t	generic_spi_write_and_read (struct no_os_spi_desc *desc, uint8_t *data, uint16_t bytes_number)
	Write and read data to/from SPI.

Variables
const struct no_os_spi_platform_ops	generic_spi_ops
	Generic platform SPI ops.

Detailed Description

Author

DBogdan (drago.nosp@m.s.bo.nosp@m.gdan@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2019(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

generic_spi_init()

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

Initialize the SPI communication peripheral.

Parameters

desc	- The SPI descriptor.
param	- The structure that contains the SPI parameters.

Returns

0 in case of success, -1 otherwise.

generic_spi_remove()

int32_t generic_spi_remove

(

struct no_os_spi_desc *

desc

)

Free the resources allocated by no_os_spi_init().

Parameters

desc	- The SPI descriptor.

Returns

0 in case of success, -1 otherwise.

generic_spi_write_and_read()

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

Write and read data to/from SPI.

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.

Variable Documentation

generic_spi_ops

const struct no_os_spi_platform_ops generic_spi_ops

Initial value:

= {
    .init = &generic_spi_init,
    .write_and_read = &generic_spi_write_and_read,
    .remove = &generic_spi_remove
}

Generic platform SPI ops.