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_units.h"
#include "no_os_alloc.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. More...
int32_t	max_spi_remove (struct no_os_spi_desc *desc)
	Free the resources allocated by no_os_spi_init(). More...
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. More...
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. More...

Variables
const struct no_os_spi_platform_ops	max_spi_ops
	maxim platform specific SPI platform ops structure More...

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 2023(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.

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,
    .dma_transfer_sync = &max_spi_dma_transfer_sync,
    .dma_transfer_async = &max_spi_dma_transfer_async,
    .remove = &max_spi_remove
}

maxim platform specific SPI platform ops structure

maxim specific SPI platform ops structure