Header file of IIO TMC5240 driver. More...

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

Classes
struct	tmc5240_iio_dev
	TMC5240 IIO device descriptor. More...

struct	tmc5240_iio_dev_init_param
	TMC5240 IIO initialization parameters. More...

Enumerations
enum	tmc5240_iio_attr { TMC5240_CH_ATTR_RAW , TMC5240_CH_ATTR_SCALE , TMC5240_CH_ATTR_CALIBSCALE , TMC5240_CH_ATTR_PRESET , TMC5240_ATTR_DIRECTION , TMC5240_ATTR_STOP , TMC5240_ATTR_AMAX , TMC5240_ATTR_VMAX , TMC5240_ATTR_DMAX , TMC5240_ATTR_VSTART , TMC5240_ATTR_A1 , TMC5240_ATTR_V1 , TMC5240_ATTR_A2 , TMC5240_ATTR_V2 , TMC5240_ATTR_D1 , TMC5240_ATTR_D2 , TMC5240_ATTR_VSTOP }
	TMC5240 IIO attribute identifiers. More...

Functions
int	tmc5240_iio_init (struct tmc5240_iio_dev *iio_dev, struct tmc5240_iio_dev_init_param init_param)
	Initializes the tmc5240 IIO driver.

int	tmc5240_iio_remove (struct tmc5240_iio_dev *desc)
	Free resources allocated by the init function.

Detailed Description

Header file of IIO TMC5240 driver.

Author: Kister Genesis Jimenez (kiste.nosp@m.r.ji.nosp@m.menez.nosp@m.@ana.nosp@m.log.c.nosp@m.om)

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.

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.

Enumeration Type Documentation

◆ tmc5240_iio_attr

enum tmc5240_iio_attr

TMC5240 IIO attribute identifiers.

Enumerator
TMC5240_CH_ATTR_RAW	Raw value attribute
TMC5240_CH_ATTR_SCALE	Scale factor attribute
TMC5240_CH_ATTR_CALIBSCALE	Calibration scale attribute
TMC5240_CH_ATTR_PRESET	Position preset attribute. Writing sets RAMPMODE to HOLD.
TMC5240_ATTR_DIRECTION	Shaft direction attribute
TMC5240_ATTR_STOP	Motor stop attribute
TMC5240_ATTR_AMAX	Maximum acceleration attribute
TMC5240_ATTR_VMAX	Maximum velocity attribute
TMC5240_ATTR_DMAX	Maximum deceleration attribute
TMC5240_ATTR_VSTART	Start velocity attribute
TMC5240_ATTR_A1	First acceleration phase attribute
TMC5240_ATTR_V1	First velocity threshold attribute
TMC5240_ATTR_A2	Second acceleration phase attribute
TMC5240_ATTR_V2	Second velocity threshold attribute
TMC5240_ATTR_D1	First deceleration phase attribute
TMC5240_ATTR_D2	Second deceleration phase attribute
TMC5240_ATTR_VSTOP	Stop velocity attribute

Function Documentation

◆ tmc5240_iio_init()

int tmc5240_iio_init	(	struct tmc5240_iio_dev **	iio_dev,
		struct tmc5240_iio_dev_init_param *	init_param )

Initializes the tmc5240 IIO driver.

Initialize the TMC5240 IIO driver

Parameters

iio_dev	- The iio device structure.
init_param	- Parameters for the initialization of iio_dev

Returns: 0 in case of success, errno errors otherwise

◆ tmc5240_iio_remove()

int tmc5240_iio_remove ( struct tmc5240_iio_dev * desc )

Free resources allocated by the init function.

Free resources allocated by tmc5240_iio_init()