Skip to content

Implement BufferParams in the python binding #1367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gastmaier wants to merge 1 commit into from
Closed

Implement BufferParams in the python binding #1367

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 59 additions & 6 deletions bindings/python/iio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,13 @@ class ContextParams(Structure):
pass # TODO

class BufferParams(Structure):
pass # TODO
"""Represents the low-level control over DMA buffer allocation."""

_fields_ = [
("idx", c_uint),
("dma_allocator", c_int),
("__rsrv", c_char * 64),
]

class DataFormat(Structure):
"""Represents the data format of an IIO channel."""
Expand Down Expand Up @@ -304,6 +310,13 @@ class ChannelType(Enum):
IIO_CHAN_TYPE_UNKNOWN = 0x7FFFFFFF


class BufferDMAAllocator(Enum):
"""Contains DMA allocator options."""

IIO_DMA_ALLOCATOR_SYSTEM = 0
IIO_DMA_ALLOCATOR_CMA_LINUX = 1


# pylint: disable=invalid-name
_ScanPtr = _POINTER(_Scan)
_ContextPtr = _POINTER(_Context)
Expand Down Expand Up @@ -814,6 +827,36 @@ def _write(self, value):
"Current value of this attribute.\n\ttype=str",
)

class ChannelsBufferParams(_IIO_Object):
"""Represents buffer creation parameters."""

def __init__(self, idx=0, dma_allocator=BufferDMAAllocator.IIO_DMA_ALLOCATOR_SYSTEM):
"""
Initialize a new instance of the ChannelsBufferParams class.

:param idx: type=int
The index of the hardware buffer. Should be 0 in most cases.
:param dma_allocator: type=BufferDMAAllocator

returns: type=iio.ChannelsBufferParams
A new instance of this class
"""
self._params = BufferParams()
self._params.idx = idx
self._params.dma_allocator = dma_allocator.value

super(ChannelsBufferParams, self).__init__(self._params, None)

@property
def idx(self):
"""Get the buffer index."""
return self._params.idx

@property
def dma_allocator(self):
"""Get the DMA allocator type."""
return self._params.dma_allocator

class ChannelsMask(_IIO_Object):
"""A bitmask where each bit corresponds to an enabled channel."""

Expand Down Expand Up @@ -1093,7 +1136,7 @@ def buffer(self):
class Buffer(_IIO_Object):
"""Represents a hardware I/O buffer."""

def __init__(self, device, mask, params):
def __init__(self, device, mask, params=None):
"""
Initialize a new instance of the Buffer class.

Expand All @@ -1102,21 +1145,23 @@ def __init__(self, device, mask, params):
operations will be performed
:param mask: type=ChannelsMask
The mask of enabled channels
:param idx: type=int
The hardware index of the buffer to use. If unsure, leave it to 0
:param params: type=ChannelsBufferParams
The parameters of the buffer to use.

returns: type=iio.Buffer
An new instance of this class
"""
if params is None:
params = ChannelsBufferParams()
try:
self._buffer = _create_buffer(device._device, params._params, mask._mask)
self._buffer = _create_buffer(device._device, _byref(params._params), mask._mask)
except Exception:
self._buffer = None
raise

super(Buffer, self).__init__(self._buffer, device)

self._idx = idx
self._params = params
self._enabled = False

def __del__(self):
Expand Down Expand Up @@ -1159,6 +1204,14 @@ def _set_enabled(self, enabled):
"List of attributes for this buffer.\n\ttype=dict of iio.Attr",
)

@property
def idx(self):
"""
Get the buffer index from the buffer parameters.
type: int
"""
return self._params.idx


class Stream(_IIO_Object):
def __init__(self, buffer, samples_count, nb_blocks = 4):
Expand Down