max149x6-base.h File Reference

Header file of MAX149X6 Base Driver. More...

#include <stdint.h>
#include <stdbool.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "no_os_util.h"

Include dependency graph for max149x6-base.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	max149x6_init_param
	Initialization parameter for the MAX149X6 device. More...
struct	max149x6_desc
	Device descriptor for MAX149X6. More...

Macros
#define	MAX149X6_FRAME_SIZE   2
#define	MAX149X6_CHIP_ADDR_MASK   NO_OS_GENMASK(7, 6)
#define	MAX149X6_ADDR_MASK   NO_OS_GENMASK(4, 1)
#define	MAX149X6_RW_MASK   NO_OS_BIT(0)

Functions
int	max149x6_reg_write (struct max149x6_desc *, uint32_t, uint32_t)
	Write the value of a device register. More...
int	max149x6_reg_read (struct max149x6_desc *, uint32_t, uint32_t *)
	Read the value of a device register. More...
int	max149x6_reg_update (struct max149x6_desc *, uint32_t, uint32_t, uint32_t)
	Update the value of a device register (read/write sequence). More...

Detailed Description

Header file of MAX149X6 Base Driver.

Author

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

Radu Sabau (radu..nosp@m.saba.nosp@m.u@ana.nosp@m.log..nosp@m.com)

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

MAX149X6_ADDR_MASK

#define MAX149X6_ADDR_MASK   NO_OS_GENMASK(4, 1)

MAX149X6_CHIP_ADDR_MASK

#define MAX149X6_CHIP_ADDR_MASK   NO_OS_GENMASK(7, 6)

MAX149X6_FRAME_SIZE

#define MAX149X6_FRAME_SIZE   2

MAX149X6_RW_MASK

#define MAX149X6_RW_MASK   NO_OS_BIT(0)

Function Documentation

max149x6_reg_read()

int max149x6_reg_read	(	struct max149x6_desc *	desc,
		uint32_t	addr,
		uint32_t *	val
	)

Read the value of a device register.

Read the value of a device register

Parameters

desc	- device descriptor for the MAX149X6
addr	- address of the register
val	- value of the register

Returns

0 in case of success, negative error code otherwise

Here is the caller graph for this function:

max149x6_reg_update()

int max149x6_reg_update	(	struct max149x6_desc *	desc,
		uint32_t	addr,
		uint32_t	mask,
		uint32_t	val
	)

Update the value of a device register (read/write sequence).

Update the value of a device register

Parameters

desc	- device descriptor for the MAX149X6
addr	- address of the register
mask	- bit mask of the field to be updated
val	- value of the masked field. Should be bit shifted by using no_os_field_prep(mask, val)

Returns

0 in case of success, negative error code otherwise

Here is the caller graph for this function:

max149x6_reg_write()

int max149x6_reg_write	(	struct max149x6_desc *	desc,
		uint32_t	addr,
		uint32_t	val
	)

Write the value of a device register.

Write the value of a device register

Parameters

desc	- device descriptor for the MAX149X6
addr	- address of the register
val	- value of the register

Returns

0 in case of success, negative error code otherwise

Here is the caller graph for this function: