no-OS
Classes | Macros | Enumerations | Functions
ad2s1210.h File Reference

Header file for the ad2s1210 driver. More...

#include <stdint.h>
#include <stdbool.h>
#include "no_os_spi.h"
#include "no_os_gpio.h"
Include dependency graph for ad2s1210.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  ad2s1210_init_param
 
struct  ad2s1210_dev
 

Macros

#define AD2S1210_REG_POSITION   0x80
 
#define AD2S1210_REG_VELOCITY   0x82
 
#define AD2S1210_REG_LOS_THRD   0x88
 
#define AD2S1210_REG_DOS_OVR_THRD   0x89
 
#define AD2S1210_REG_DOS_MIS_THRD   0x8A
 
#define AD2S1210_REG_DOS_RST_MAX_THRD   0x8B
 
#define AD2S1210_REG_DOS_RST_MIN_THRD   0x8C
 
#define AD2S1210_REG_LOT_HIGH_THRD   0x8D
 
#define AD2S1210_REG_LOT_LOW_THRD   0x8E
 
#define AD2S1210_REG_EXCIT_FREQ   0x91
 
#define AD2S1210_REG_CONTROL   0x92
 
#define AD2S1210_CONTROL_RES_MASK   NO_OS_GENMASK(1, 0)
 
#define AD2S1210_CONTROL_RES0_MASK   NO_OS_BIT(0)
 
#define AD2S1210_CONTROL_RES1_MASK   NO_OS_BIT(1)
 
#define AD2S1210_ENABLE_HYSTERESIS   NO_OS_BIT(4)
 
#define AD2S1210_REG_SOFT_RESET   0xF0
 
#define AD2S1210_REG_FAULT   0xFF
 
#define AD2S1210_REG_MIN   AD2S1210_REG_POSITION
 
#define AD2S1210_MIN_CLKIN   6144000
 
#define AD2S1210_MAX_CLKIN   10240000
 
#define AD2S1210_MIN_EXCIT   2000
 
#define AD2S1210_MAX_EXCIT   20000
 
#define AD2S1210_STEP_EXCIT   250
 
#define AD2S1210_MIN_FCW   0x4
 
#define AD2S1210_MAX_FCW   0x50
 
#define AD2S1210_POS_MASK   NO_OS_BIT(0)
 
#define AD2S1210_VEL_MASK   NO_OS_BIT(1)
 

Enumerations

enum  ad2s1210_mode {
  MODE_POS,
  MODE_RESERVED,
  MODE_VEL,
  MODE_CONFIG
}
 
enum  ad2s1210_res {
  AD2S1210_RES_10BIT,
  AD2S1210_RES_12BIT,
  AD2S1210_RES_14BIT,
  AD2S1210_RES_16BIT
}
 
enum  ad2s1210_channel {
  AD2S1210_POS,
  AD2S1210_VEL
}
 

Functions

int ad2s1210_init (struct ad2s1210_dev **dev, struct ad2s1210_init_param *init_param)
 
int ad2s1210_remove (struct ad2s1210_dev *dev)
 Remove the driver's descriptor by freeing the associated resources. More...
 
int ad2s1210_reg_write (struct ad2s1210_dev *dev, uint8_t addr, uint8_t val)
 
int ad2s1210_reg_read (struct ad2s1210_dev *dev, uint8_t addr, uint8_t *val)
 
int ad2s1210_spi_single_conversion (struct ad2s1210_dev *dev, uint32_t active_mask, void *data, uint32_t size)
 Returns the result of a conversion. More...
 
int ad2s1210_hysteresis_is_enabled (struct ad2s1210_dev *dev)
 
int ad2s1210_set_hysteresis (struct ad2s1210_dev *dev, bool enable)
 
int ad2s1210_reinit_excitation_frequency (struct ad2s1210_dev *dev, uint16_t fexcit)
 
int ad2s1210_get_excitation_frequency (struct ad2s1210_dev *dev, uint16_t *fexcit)
 

Detailed Description

Header file for the ad2s1210 driver.

Author
Axel Haslam (ahasl.nosp@m.am@b.nosp@m.aylib.nosp@m.re.c.nosp@m.om)

Copyright (c) 2023 Analog Devices, Inc. Copyright (c) 2023 BayLibre, SAS.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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.
  3. 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.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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

◆ AD2S1210_CONTROL_RES0_MASK

#define AD2S1210_CONTROL_RES0_MASK   NO_OS_BIT(0)

◆ AD2S1210_CONTROL_RES1_MASK

#define AD2S1210_CONTROL_RES1_MASK   NO_OS_BIT(1)

◆ AD2S1210_CONTROL_RES_MASK

#define AD2S1210_CONTROL_RES_MASK   NO_OS_GENMASK(1, 0)

◆ AD2S1210_ENABLE_HYSTERESIS

#define AD2S1210_ENABLE_HYSTERESIS   NO_OS_BIT(4)

◆ AD2S1210_MAX_CLKIN

#define AD2S1210_MAX_CLKIN   10240000

◆ AD2S1210_MAX_EXCIT

#define AD2S1210_MAX_EXCIT   20000

◆ AD2S1210_MAX_FCW

#define AD2S1210_MAX_FCW   0x50

◆ AD2S1210_MIN_CLKIN

#define AD2S1210_MIN_CLKIN   6144000

◆ AD2S1210_MIN_EXCIT

#define AD2S1210_MIN_EXCIT   2000

◆ AD2S1210_MIN_FCW

#define AD2S1210_MIN_FCW   0x4

◆ AD2S1210_POS_MASK

#define AD2S1210_POS_MASK   NO_OS_BIT(0)

◆ AD2S1210_REG_CONTROL

#define AD2S1210_REG_CONTROL   0x92

◆ AD2S1210_REG_DOS_MIS_THRD

#define AD2S1210_REG_DOS_MIS_THRD   0x8A

◆ AD2S1210_REG_DOS_OVR_THRD

#define AD2S1210_REG_DOS_OVR_THRD   0x89

◆ AD2S1210_REG_DOS_RST_MAX_THRD

#define AD2S1210_REG_DOS_RST_MAX_THRD   0x8B

◆ AD2S1210_REG_DOS_RST_MIN_THRD

#define AD2S1210_REG_DOS_RST_MIN_THRD   0x8C

◆ AD2S1210_REG_EXCIT_FREQ

#define AD2S1210_REG_EXCIT_FREQ   0x91

◆ AD2S1210_REG_FAULT

#define AD2S1210_REG_FAULT   0xFF

◆ AD2S1210_REG_LOS_THRD

#define AD2S1210_REG_LOS_THRD   0x88

◆ AD2S1210_REG_LOT_HIGH_THRD

#define AD2S1210_REG_LOT_HIGH_THRD   0x8D

◆ AD2S1210_REG_LOT_LOW_THRD

#define AD2S1210_REG_LOT_LOW_THRD   0x8E

◆ AD2S1210_REG_MIN

#define AD2S1210_REG_MIN   AD2S1210_REG_POSITION

◆ AD2S1210_REG_POSITION

#define AD2S1210_REG_POSITION   0x80

◆ AD2S1210_REG_SOFT_RESET

#define AD2S1210_REG_SOFT_RESET   0xF0

◆ AD2S1210_REG_VELOCITY

#define AD2S1210_REG_VELOCITY   0x82

◆ AD2S1210_STEP_EXCIT

#define AD2S1210_STEP_EXCIT   250

◆ AD2S1210_VEL_MASK

#define AD2S1210_VEL_MASK   NO_OS_BIT(1)

Enumeration Type Documentation

◆ ad2s1210_channel

enum ad2s1210_channel
Enumerator
AD2S1210_POS 
AD2S1210_VEL 

◆ ad2s1210_mode

enum ad2s1210_mode
Enumerator
MODE_POS 
MODE_RESERVED 
MODE_VEL 
MODE_CONFIG 

◆ ad2s1210_res

enum ad2s1210_res
Enumerator
AD2S1210_RES_10BIT 
AD2S1210_RES_12BIT 
AD2S1210_RES_14BIT 
AD2S1210_RES_16BIT 

Function Documentation

◆ ad2s1210_get_excitation_frequency()

int ad2s1210_get_excitation_frequency ( struct ad2s1210_dev *  dev,
uint16_t *  fexcit 
)

◆ ad2s1210_hysteresis_is_enabled()

int ad2s1210_hysteresis_is_enabled ( struct ad2s1210_dev *  dev)

◆ ad2s1210_init()

int ad2s1210_init ( struct ad2s1210_dev **  dev,
struct ad2s1210_init_param *  init_param 
)

◆ ad2s1210_reg_read()

int ad2s1210_reg_read ( struct ad2s1210_dev *  dev,
uint8_t  addr,
uint8_t *  val 
)
Here is the caller graph for this function:

◆ ad2s1210_reg_write()

int ad2s1210_reg_write ( struct ad2s1210_dev *  dev,
uint8_t  addr,
uint8_t  val 
)
Here is the caller graph for this function:

◆ ad2s1210_reinit_excitation_frequency()

int ad2s1210_reinit_excitation_frequency ( struct ad2s1210_dev *  dev,
uint16_t  fexcit 
)

◆ ad2s1210_remove()

int ad2s1210_remove ( struct ad2s1210_dev *  dev)

Remove the driver's descriptor by freeing the associated resources.

Parameters
dev- Device descriptor.
Returns
Returns negative error code or 0 in case of success. Example: -EINVAL - Bad input parameters. 0 - No errors encountered.

◆ ad2s1210_set_hysteresis()

int ad2s1210_set_hysteresis ( struct ad2s1210_dev *  dev,
bool  enable 
)

◆ ad2s1210_spi_single_conversion()

int ad2s1210_spi_single_conversion ( struct ad2s1210_dev *  dev,
uint32_t  active_mask,
void *  data,
uint32_t  size 
)

Returns the result of a conversion.

Parameters
dev- The device structure.
active_mask- mask of active channels angle = bit 0, velocity = bit 1
data- Buffer to store sampled register data.
size- size in bytes of the data buffer
Returns
0 in case of success or negative error code.
Generated by   doxygen 1.8.17