This module contains WINC3400 bus wrapper APIs declarations. More...

#include "common/include/nm_common.h"

Include dependency graph for nm_bus_wrapper.h:

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

Classes
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)

#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)

#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 (uint8 *req_com_port, uint32 req_serial_number)

sint8	nm_bus_ioctl (uint8 u8Cmd, void *pvParameter)

sint8	nm_bus_reinit (void *)

Variables
tstrNmBusCapabilities	egstrNmBusCapabilities

Detailed Description

This module contains WINC3400 bus wrapper APIs declarations.

Definition in file nm_bus_wrapper.h.

Macro Definition Documentation

◆ NM_BUS_IOCTL_R

#define NM_BUS_IOCTL_R ((uint8)0)

IOCTL commandsRead only ==> I2C/UART. Parameter:tstrNmI2cDefault/tstrNmUartDefault

Definition at line 49 of file nm_bus_wrapper.h.

◆ NM_BUS_IOCTL_RW

#define NM_BUS_IOCTL_RW ((uint8)3)

Read/Write at the same time ==> SPI only. Parameter:tstrNmSpiRw

Definition at line 54 of file nm_bus_wrapper.h.

◆ NM_BUS_IOCTL_W

#define NM_BUS_IOCTL_W ((uint8)1)

Write only ==> I2C/UART. Parameter type tstrNmI2cDefault/tstrNmUartDefault

Definition at line 50 of file nm_bus_wrapper.h.

◆ NM_BUS_IOCTL_W_SPECIAL

#define NM_BUS_IOCTL_W_SPECIAL ((uint8)2)

Write two buffers within the same transaction (same start/stop conditions) ==> I2C only. Parameter:tstrNmI2cSpecial

Definition at line 51 of file nm_bus_wrapper.h.

◆ NM_BUS_IOCTL_WR_RESTART

#define NM_BUS_IOCTL_WR_RESTART ((uint8)4)

Write buffer then made restart condition then read ==> I2C only. parameter:tstrNmI2cSpecial

Definition at line 56 of file nm_bus_wrapper.h.

◆ NM_BUS_TYPE_I2C

#define NM_BUS_TYPE_I2C ((uint8)0)

BUS Type

Definition at line 43 of file nm_bus_wrapper.h.

◆ NM_BUS_TYPE_SPI

#define NM_BUS_TYPE_SPI ((uint8)1)

Definition at line 44 of file nm_bus_wrapper.h.

◆ NM_BUS_TYPE_UART

#define NM_BUS_TYPE_UART ((uint8)2)

Definition at line 45 of file nm_bus_wrapper.h.

Function Documentation

◆ nm_bus_deinit()

nm_bus_deinit ( void )

De-initialize the bus wrapper.

Returns: ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure

Definition at line 326 of file nm_bus_wrapper_same70.c.

◆ nm_bus_init()

sint8 nm_bus_init	(	uint8 *	req_com_port,
		uint32	req_serial_number
	)

◆ nm_bus_ioctl()

sint8 nm_bus_ioctl	(	uint8	u8Cmd,
		void *	pvParameter
	)

Definition at line 285 of file nm_bus_wrapper_same70.c.

◆ nm_bus_reinit()

sint8 nm_bus_reinit ( void * )

Variable Documentation

◆ egstrNmBusCapabilities

tstrNmBusCapabilities egstrNmBusCapabilities

Definition at line 51 of file nm_bus_wrapper_same70.c.

Classes

Macros

Functions

Variables