maxim_spi.c File Reference

Implementation of SPI driver. More...

#include <stdlib.h>
#include <errno.h>
#include "spi.h"
#include "mxc_errors.h"
#include "mxc_pins.h"
#include "maxim_spi.h"
#include "maxim_dma.h"
#include "no_os_delay.h"
#include "no_os_print_log.h"
#include "no_os_util.h"
#include "no_os_alloc.h"
#include "no_os_units.h"
#include "no_os_dma.h"

Include dependency graph for maxim_spi.c:

Classes
struct	max_dma_spi_xfer_data

Macros
#define	SPI_MASTER_MODE   1
#define	SPI_SINGLE_MODE   0
#define	MAX_DELAY_SCLK   255
#define	NS_PER_US   1000

Functions
int32_t	max_spi_init (struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
	Initialize the SPI communication peripheral.
int32_t	max_spi_remove (struct no_os_spi_desc *desc)
	Free the resources allocated by no_os_spi_init().
int32_t	max_spi_transfer (struct no_os_spi_desc *desc, struct no_os_spi_msg *msgs, uint32_t len)
	Write/read multiple messages to/from SPI.
int32_t	max_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	max_spi_ops
	maxim platform specific SPI platform ops structure

Detailed Description

Implementation of SPI driver.

Author

Ciprian Regus (cipri.nosp@m.an.r.nosp@m.egus@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2022(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Macro Definition Documentation

MAX_DELAY_SCLK

#define MAX_DELAY_SCLK   255

NS_PER_US

#define NS_PER_US   1000

SPI_MASTER_MODE

#define SPI_MASTER_MODE   1

SPI_SINGLE_MODE

#define SPI_SINGLE_MODE   0

Function Documentation

max_spi_init()

int32_t max_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, errno codes otherwise.

max_spi_remove()

int32_t max_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, errno codes otherwise.

max_spi_transfer()

int32_t max_spi_transfer	(	struct no_os_spi_desc *	desc,
		struct no_os_spi_msg *	msgs,
		uint32_t	len )

Write/read multiple messages to/from SPI.

Parameters

desc	- The SPI descriptor.
msgs	- The messages array.
len	- Number of messages.

Returns

0 in case of success, errno codes otherwise.

max_spi_write_and_read()

int32_t max_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, errno codes otherwise.

Variable Documentation

max_spi_ops

const struct no_os_spi_platform_ops max_spi_ops

Initial value:

= {
    .init = &max_spi_init,
    .write_and_read = &max_spi_write_and_read,
    .transfer = &max_spi_transfer,
    .transfer_dma = &max_spi_transfer_dma,
    .transfer_dma_async = &max_spi_transfer_dma_async,
    .remove = &max_spi_remove
}

maxim platform specific SPI platform ops structure

maxim specific SPI platform ops structure