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:

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.
int	max149x6_reg_read (struct max149x6_desc *, uint32_t, uint32_t *)
	Read the value of a device register.
int	max149x6_reg_update (struct max149x6_desc *, uint32_t, uint32_t, uint32_t)
	Update the value of a device register (read/write sequence).

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.

SPDX-License-Identifier: BSD-3-Clause

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

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

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