Contains the base functionality for flink. More...

#include "flinklib.h"
#include "flinkioctl.h"
#include "types.h"
#include "valid.h"
#include "error.h"
#include "log.h"
#include <stdlib.h>
#include <fcntl.h>
#include <unistd.h>

Include dependency graph for base.c:

Go to the source code of this file.

Functions
flink_dev *	flink_open (const char *file_name)
	Opens a flink device file. More...

int	flink_close (flink_dev *dev)
	Close an open flink device. More...

int	flink_get_nof_subdevices (flink_dev *dev)
	Returns the number of subdevices of a fink device. More...

int	flink_subdevice_reset (flink_subdev *subdev)
	Reset a flink subdevice. More...

int	flink_subdevice_select (flink_subdev *subdev, uint8_t exclusive)
	Select a flink subdevice for further operations. More...

flink_subdev *	flink_get_subdevice_by_id (flink_dev *dev, uint8_t subdev_id)
	Find subdevice of a device with a given id. More...

flink_subdev *	flink_get_subdevice_by_unique_id (flink_dev *dev, uint8_t unique_id)
	Find subdevice of a device with a given unique id. More...

uint8_t	flink_subdevice_get_id (flink_subdev *subdev)
	Get the id of a subdevice. More...

uint16_t	flink_subdevice_get_function (flink_subdev *subdev)
	Get the function of a subdevice. More...

uint8_t	flink_subdevice_get_subfunction (flink_subdev *subdev)
	Get the subfunction of a subdevice. More...

uint8_t	flink_subdevice_get_function_version (flink_subdev *subdev)
	Get the function version of a subdevice. More...

uint32_t	flink_subdevice_get_baseaddr (flink_subdev *subdev)
	Get the base address of a subdevice. More...

uint32_t	flink_subdevice_get_memsize (flink_subdev *subdev)
	Get the memory size of a subdevice. More...

uint32_t	flink_subdevice_get_nofchannels (flink_subdev *subdev)
	Get the number of channels of a subdevice. More...

uint32_t	flink_subdevice_get_unique_id (flink_subdev *subdev)
	Get the unique id of a subdevice. More...

Detailed Description

Contains the base functionality for flink.

Contains functions to initialize, add and remove flink devices and subdevices

Author: Martin Züger; Urs Graf

Definition in file base.c.

Function Documentation

int flink_close ( flink_dev * dev )

Close an open flink device.

Parameters

dev	device to close.

Returns: int: 0 on success, -1 in case of failure.

Definition at line 145 of file base.c.

Here is the caller graph for this function:

int flink_get_nof_subdevices ( flink_dev * dev )

Returns the number of subdevices of a fink device.

Parameters

dev	Device to read

Returns: int: Number of flink devices or -1 in case of error.

Definition at line 169 of file base.c.

flink_subdev* flink_get_subdevice_by_id	(	flink_dev *	dev,
		uint8_t	subdev_id
	)

Find subdevice of a device with a given id.

Parameters

dev	Device to search.
subdev_id	Id of subdevice.

Returns: flink_subdev*: Pointer to the subdevice or NULL in case of error.

Definition at line 225 of file base.c.

Here is the caller graph for this function:

flink_subdev* flink_get_subdevice_by_unique_id	(	flink_dev *	dev,
		uint8_t	unique_id
	)

Find subdevice of a device with a given unique id.

Parameters

dev	Device to search.
unique_id	Unique id of subdevice.

Returns: flink_subdev*: Pointer to the subdevice or NULL in case of error.

Definition at line 248 of file base.c.

flink_dev* flink_open ( const char * file_name )

Opens a flink device file.

Parameters

file_name Device file (null terminated array).

Returns: flink_dev*: Pointer to the opened flink device or NULL in case of error.

Definition at line 112 of file base.c.

Here is the caller graph for this function:

uint32_t flink_subdevice_get_baseaddr ( flink_subdev * subdev )

Get the base address of a subdevice.

Parameters

subdev The subdevice.

Returns: uint32_t: Returns the base address.

Definition at line 307 of file base.c.

uint16_t flink_subdevice_get_function ( flink_subdev * subdev )

Get the function of a subdevice.

Parameters

subdev The subdevice.

Returns: uint16_t: Returns the function id.

Definition at line 280 of file base.c.

uint8_t flink_subdevice_get_function_version ( flink_subdev * subdev )

Get the function version of a subdevice.

Parameters

subdev The subdevice.

Returns: uint8_t: Returns the function version.

Definition at line 298 of file base.c.

uint8_t flink_subdevice_get_id ( flink_subdev * subdev )

Get the id of a subdevice.

Parameters

subdev The subdevice.

Returns: uint8_t: Id of the subdevice.

Definition at line 271 of file base.c.

uint32_t flink_subdevice_get_memsize ( flink_subdev * subdev )

Get the memory size of a subdevice.

Parameters

subdev The subdevice.

Returns: uint32_t: Returns the memory size.

Definition at line 316 of file base.c.

uint32_t flink_subdevice_get_nofchannels ( flink_subdev * subdev )

Get the number of channels of a subdevice.

Parameters

subdev The subdevice.

Returns: uint32_t: Returns the number of channels.

Definition at line 325 of file base.c.

uint8_t flink_subdevice_get_subfunction ( flink_subdev * subdev )

Get the subfunction of a subdevice.

Parameters

subdev The subdevice.

Returns: uint8_t: Returns the subfunction id.

Definition at line 289 of file base.c.

uint32_t flink_subdevice_get_unique_id ( flink_subdev * subdev )

Get the unique id of a subdevice.

Parameters

subdev The subdevice.

Returns: uint32_t: Returns the unique id.

Definition at line 334 of file base.c.

int flink_subdevice_reset ( flink_subdev * subdev )

Reset a flink subdevice.

Parameters

subdev Subdevice to reset

Returns: int: 0 on success, else -1.

Definition at line 185 of file base.c.

int flink_subdevice_select	(	flink_subdev *	subdev,
		uint8_t	exclusive
	)

Select a flink subdevice for further operations.

Parameters

subdev	Subdevice to select.
exclusive	Block access to this subdevice for other processes.

Returns: int: 0 on success, else -1.

Definition at line 208 of file base.c.

Functions

Detailed Description

Function Documentation