lr1110_regmem.h File Reference

Register/memory driver definition for LR1110. More...

#include <stdint.h>
#include "common/lr1110_types.h"
#include "common/lr1110_hal.h"

Go to the source code of this file.

Functions
err_t	lr1110_regmem_write_regmem32 (lriot_t *ctx, uint32_t address, uint32_t *buffer, uint8_t length)
	Write words into register memory space of LR1110.
err_t	lr1110_regmem_read_regmem32 (lriot_t *ctx, uint32_t address, uint32_t *buffer, uint8_t length)
	Read words into register memory space of LR1110.
err_t	lr1110_regmem_write_mem8 (lriot_t *ctx, uint32_t address, uint8_t *buffer, uint8_t length)
	Write bytes into register memory space of LR1110.
err_t	lr1110_regmem_read_mem8 (lriot_t *ctx, uint32_t address, uint8_t *buffer, uint8_t length)
	Read bytes into register memory space of LR1110.
err_t	lr1110_regmem_write_buffer8 (lriot_t *ctx, uint8_t *buffer, uint8_t length)
	Write bytes into radio TX buffer memory space of LR1110.
err_t	lr1110_regmem_read_buffer8 (lriot_t *ctx, uint8_t *buffer, uint8_t offset, uint8_t length)
	Read bytes from radio RX buffer memory space of LR1110.
err_t	lr1110_regmem_clear_rxbuffer (lriot_t *ctx)
	Clear radio RX buffer.
err_t	lr1110_regmem_write_regmem32_mask (lriot_t *ctx, uint32_t address, uint32_t mask, uint32_t data_buf)
	Read-modify-write data at given register/memory address.

Detailed Description

Register/memory driver definition for LR1110.

The Clear BSD License Copyright Semtech Corporation 2021. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) 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 the Semtech corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 SEMTECH CORPORATION 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.

Function Documentation

lr1110_regmem_clear_rxbuffer()

err_t lr1110_regmem_clear_rxbuffer

(

lriot_t *

ctx

)

Clear radio RX buffer.

Set to 0x00 all content of the radio RX buffer

Parameters

[in]

ctx

Chip implementation context

Returns

Operation status

lr1110_regmem_read_buffer8()

err_t lr1110_regmem_read_buffer8	(	lriot_t *	ctx,
		uint8_t *	buffer,
		uint8_t	offset,
		uint8_t	length )

Read bytes from radio RX buffer memory space of LR1110.

Parameters

[in]	ctx	Chip implementation context
[out]	buffer	Pointer to a byte array to be filled with content from radio buffer. Its size must be enough to contain at least length bytes
[in]	offset	Memory offset to start reading
[in]	length	Number of bytes to read from radio buffer

Returns

Operation status

See also

lr1110_regmem_write_buffer8

lr1110_regmem_read_mem8()

err_t lr1110_regmem_read_mem8	(	lriot_t *	ctx,
		uint32_t	address,
		uint8_t *	buffer,
		uint8_t	length )

Read bytes into register memory space of LR1110.

A byte is 8-bit long. The reading operations read contiguously from register memory, starting at the address provided.

Parameters

[in]	ctx	Chip implementation context
[in]	address	The register memory address to start reading operation
[in]	buffer	Pointer to a byte array to be filled with content from memory. Its size must be enough to contain at least length bytes
[in]	length	Number of bytes to read from memory

Returns

Operation status

See also

lr1110_regmem_write_mem8

lr1110_regmem_read_regmem32()

err_t lr1110_regmem_read_regmem32	(	lriot_t *	ctx,
		uint32_t	address,
		uint32_t *	buffer,
		uint8_t	length )

Read words into register memory space of LR1110.

A word is 32-bit long. The reading operations read contiguously from register memory, starting at the address provided.

Parameters

[in]	ctx	Chip implementation context
[in]	address	The register memory address to start reading operation
[out]	buffer	Pointer to a words array to be filled with content from memory. Its size must be enough to contain at least length words.
[in]	length	Number of words to read from memory

Returns

Operation status

See also

lr1110_regmem_write_regmem32

lr1110_regmem_write_buffer8()

err_t lr1110_regmem_write_buffer8	(	lriot_t *	ctx,
		uint8_t *	buffer,
		uint8_t	length )

Write bytes into radio TX buffer memory space of LR1110.

Parameters

[in]	ctx	Chip implementation context
[in]	data_	The buffer of bytes to write into radio buffer. Its size must be enough to contain length bytes
[in]	length	Number of bytes to write into radio buffer

Returns

Operation status

See also

lr1110_regmem_read_buffer8

lr1110_regmem_write_mem8()

err_t lr1110_regmem_write_mem8	(	lriot_t *	ctx,
		uint32_t	address,
		uint8_t *	buffer,
		uint8_t	length )

Write bytes into register memory space of LR1110.

A byte is 8-bit long. The writing operations write contiguously in register memory, starting at the address provided.

Parameters

[in]	ctx	Chip implementation context
[in]	address	The register memory address to start writing operation
[in]	buffer	The buffer of bytes to write into memory. Its size must be enough to contain length bytes
[in]	length	Number of bytes to write into memory

Returns

Operation status

See also

lr1110_regmem_read_mem8

lr1110_regmem_write_regmem32()

err_t lr1110_regmem_write_regmem32	(	lriot_t *	ctx,
		uint32_t	address,
		uint32_t *	buffer,
		uint8_t	length )

Write words into register memory space of LR1110.

A word is 32-bit long. The writing operations write contiguously in register memory, starting at the address provided.

Parameters

[in]	ctx	Chip implementation context
[in]	address	The register memory address to start writing operation
[in]	buffer	The buffer of words to write into memory. Its size must be enough to contain length words.
[in]	length	Number of words to write into memory

Returns

Operation status

See also

lr1110_regmem_read_regmem32

lr1110_regmem_write_regmem32_mask()

err_t lr1110_regmem_write_regmem32_mask	(	lriot_t *	ctx,
		uint32_t	address,
		uint32_t	mask,
		uint32_t	data_buf )

Read-modify-write data at given register/memory address.

Parameters

[in]	ctx	Chip implementation context
[in]	address	The register memory address to be modified
[in]	mask	The mask to be applied on read data
[in]	data_buf	The data to be written

Returns

Operation status