This module contains NMC1000 bus wrapper APIs declarations.
Copyright (c) 2016-2021 Microchip Technology Inc. and its subsidiaries.
#include "common/include/nm_common.h"
Data Structures | |
struct | tstrNmBusCapabilities |
Structure holding bus capabilities information. More... | |
struct | tstrNmI2cDefault |
Structure holding I2C default operation parameters. More... | |
struct | tstrNmI2cSpecial |
Structure holding I2C special operation parameters. More... | |
struct | tstrNmSpiRw |
Structure holding SPI R/W parameters. More... | |
struct | tstrNmUartDefault |
Structure holding UART default operation parameters. More... | |
Macros | |
#define | NM_BUS_IOCTL_R ((uint8)0) |
IOCTL commands. More... | |
#define | NM_BUS_IOCTL_RW ((uint8)3) |
#define | NM_BUS_IOCTL_W ((uint8)1) |
#define | NM_BUS_IOCTL_W_SPECIAL ((uint8)2) |
#define | NM_BUS_IOCTL_WR_RESTART ((uint8)4) |
#define | NM_BUS_TYPE_I2C ((uint8)0) |
BUS Type. More... | |
#define | NM_BUS_TYPE_SPI ((uint8)1) |
#define | NM_BUS_TYPE_UART ((uint8)2) |
Functions | |
sint8 | nm_bus_deinit (void) |
De-initialize the bus wrapper. More... | |
sint8 | nm_bus_init (void *) |
sint8 | nm_bus_ioctl (uint8 u8Cmd, void *pvParameter) |
sint8 | nm_bus_reinit (void *) |
Variables | |
tstrNmBusCapabilities | egstrNmBusCapabilities |
#define NM_BUS_IOCTL_R ((uint8)0) |
IOCTL commands.
Read only ==> I2C/UART. Parameter:tstrNmI2cDefault/tstrNmUartDefault
#define NM_BUS_IOCTL_RW ((uint8)3) |
Read/Write at the same time ==> SPI only. Parameter:tstrNmSpiRw
#define NM_BUS_IOCTL_W ((uint8)1) |
Write only ==> I2C/UART. Parameter type tstrNmI2cDefault/tstrNmUartDefault
#define NM_BUS_IOCTL_W_SPECIAL ((uint8)2) |
Write two buffers within the same transaction (same start/stop conditions) ==> I2C only. Parameter:tstrNmI2cSpecial
#define NM_BUS_IOCTL_WR_RESTART ((uint8)4) |
Write buffer then made restart condition then read ==> I2C only. parameter:tstrNmI2cSpecial
#define NM_BUS_TYPE_I2C ((uint8)0) |
BUS Type.
#define NM_BUS_TYPE_SPI ((uint8)1) |
#define NM_BUS_TYPE_UART ((uint8)2) |
sint8 nm_bus_deinit | ( | void | ) |
De-initialize the bus wrapper.
References IOPORT_DIR_INPUT, ioport_set_pin_dir(), M2M_SUCCESS, and spi_disable().
Referenced by nm_bus_iface_deinit().
sint8 nm_bus_init | ( | void * | ) |
References IOPORT_DIR_OUTPUT, ioport_disable_pin(), ioport_enable_pin(), ioport_set_pin_dir(), ioport_set_pin_mode(), M2M_ERR, M2M_SUCCESS, twihs_options::master_clk, nm_bsp_reset(), nm_bsp_sleep(), PIO_DELTA, pmc_enable_periph_clk(), twihs_options::speed, SPI_DEASSERT_CS, spi_disable(), spi_disable_mode_fault_detect(), spi_enable(), spi_enable_clock(), spi_reset(), spi_set_baudrate_div(), spi_set_bits_per_transfer(), spi_set_clock_phase(), spi_set_clock_polarity(), spi_set_master_mode(), spi_set_peripheral_chip_select_value(), spi_set_transfer_delay(), sysclk_get_peripheral_hz(), twihs_master_init(), and TWIHS_SUCCESS.
References M2M_ERR, NM_BUS_IOCTL_R, NM_BUS_IOCTL_RW, NM_BUS_IOCTL_W, NM_BUS_IOCTL_W_SPECIAL, tstrNmI2cDefault::pu8Buf, tstrNmI2cSpecial::pu8Buf1, tstrNmI2cSpecial::pu8Buf2, tstrNmSpiRw::pu8InBuf, tstrNmSpiRw::pu8OutBuf, spi_xdmac_configure(), tstrNmI2cDefault::u16Sz, tstrNmSpiRw::u16Sz, tstrNmI2cSpecial::u16Sz1, and tstrNmI2cSpecial::u16Sz2.
sint8 nm_bus_reinit | ( | void * | ) |
tstrNmBusCapabilities egstrNmBusCapabilities |
Referenced by nm_read_block(), and nm_write_block().