2.8 SPI Digipot MCP41HV51 Driver

2.8.1 Introduction

The MPLAB® Code Configurator Melody SPI Digi POT MCP41HV51 driver allows quick and easy configuration and code generation to enable microcontrollers to interface with the MCP41HV51 Digital Potentiometer using the SPI protocol.

2.8.2 Module Documentation

2.8.2.1 SPI Digi POT MCP41HV51

This file provides APIs declarations for the SPI Digi POT MCP41HV51 driver.

2.8.2.1.1 Module description

This file provides APIs declarations for the SPI Digi POT MCP41HV51 driver.

Version: SPI Digi POT MCP41HV51 Driver Version 1.0.0

Enumerations

enum mcp41hv51_cmd { WRITE_DATA, INCREMENT_WIPER, DECREMENT_WIPER, READ_DATA }

SPI Digi POT MCP41HV51 Commands:

Functions

void MCP41HV51_Initialize (void)

Initializes the SPI Digi POT MCP41HV51.
void MCP41HV51_Wiper0Write (uint8_t data)

Writes to the SPI Digi POT MCP41HV51 Wiper0 register.
uint8_t MCP41HV51_Wiper0Read (void)

Reads from the SPI Digi POT MCP41HV51 Wiper0 register.
void MCP41HV51_Wiper0Increment (void)

Increments the SPI Digi POT MCP41HV51 Wiper0 register.
void MCP41HV51_Wiper0Decrement (void)

Decrements the SPI Digi POT MCP41HV51 Wiper0 register.
void MCP41HV51_TconRegWrite (uint8_t data)

Writes to the SPI Digi POT MCP41HV51 TCON register.
uint8_t MCP41HV51_TconRegRead (void)

Reads from the SPI Digi POT MCP41HV51 TCON register.
void MCP41HV51_Enable (void)

Enables the SPI Digi POT MCP41HV51.
void MCP41HV51_Disable (void)

Disables the SPI Digi POT MCP41HV51.
void MCP41HV51_HardwareShutdownEnable (void)

Forces the SPI Digi POT MCP41HV51 into Hardware Shutdown mode.
void MCP41HV51_HardwareShutdownDisable (void)

Removes the SPI Digi POT MCP41HV51 from Hardware Shutdown mode.
void MCP41HV51_Write (uint8_t *buffer, uint8_t bufferSize)

Writes to the SPI Digi POT MCP41HV51.
void MCP41HV51_Read (uint8_t *buffer, uint8_t bufferSize)

Reads from the SPI Digi POT MCP41HV51.

2.8.2.1.2 Function Documentation

MCP41HV51_Disable()

void MCP41HV51_Disable (void )

Disables the SPI Digi POT MCP41HV51.

Precondition:
An SPI Host driver is generated.

Parameters:


None.

Returns:
None.

MCP41HV51_Enable()

void MCP41HV51_Enable (void )

Enables the SPI Digi POT MCP41HV51.

Precondition:
An SPI Host driver is generated.

Parameters:


None.

Returns:
None.

MCP41HV51_HardwareShutdownDisable()

void MCP41HV51_HardwareShutdownDisable (void )

Removes the SPI Digi POT MCP41HV51 from Hardware Shutdown mode.

Precondition:
An SPI Host driver is generated.

Parameters:


None.

Returns:
None.

MCP41HV51_HardwareShutdownEnable()

void MCP41HV51_HardwareShutdownEnable (void )

Forces the SPI Digi POT MCP41HV51 into Hardware Shutdown mode.

Precondition:
An SPI Host driver is generated.

Parameters:


None.

Returns:
None.

MCP41HV51_Initialize()

void MCP41HV51_Initialize (void )

Initializes the SPI Digi POT MCP41HV51.

Precondition:
An SPI Host driver is generated.

Parameters:


None.

Returns:
None.

MCP41HV51_Read()

void MCP41HV51_Read (uint8_t * buffer, uint8_t bufferSize)

Reads from the SPI Digi POT MCP41HV51.

Precondition:
An SPI Host driver is generated, and SPI Digi POT MCP41HV51 is initialized.

Parameters:


uint8_t	*buffer - Pointer to a user-defined buffer that will contain the data bytes received.
uint8_t	bufferSize - Number of data bytes to be received.

Returns:
None.

MCP41HV51_TconRegRead()

uint8_t MCP41HV51_TconRegRead (void )

Reads from the SPI Digi POT MCP41HV51 TCON register.

Precondition:
An SPI Host driver is generated, and SPI Digi POT MCP41HV51 is initialized.

Parameters:


None.

Returns:
uint8_t TCON register data.

MCP41HV51_TconRegWrite()

void MCP41HV51_TconRegWrite (uint8_t data)

Writes to the SPI Digi POT MCP41HV51 TCON register.

Precondition:
An SPI Host driver is generated, and SPI Digi POT MCP41HV51 is initialized.

Parameters:


uint8_t	data - Data to be written to the TCON register.

Returns:
None.

MCP41HV51_Wiper0Decrement()

void MCP41HV51_Wiper0Decrement (void )

Decrements the SPI Digi POT MCP41HV51 Wiper0 register.

Precondition:
An SPI Host driver is generated, and SPI Digi POT MCP41HV51 is initialized.

Parameters:


None.

Returns:
None.

MCP41HV51_Wiper0Increment()

void MCP41HV51_Wiper0Increment (void )

Increments the SPI Digi POT MCP41HV51 Wiper0 register.

Precondition:
An SPI Host driver is generated, and SPI Digi POT MCP41HV51 is initialized.

Parameters:


None.

Returns:
None.

MCP41HV51_Wiper0Read()

uint8_t MCP41HV51_Wiper0Read (void )

Reads from the SPI Digi POT MCP41HV51 Wiper0 register.

Precondition:
An SPI Host driver is generated, and SPI Digi POT MCP41HV51 is initialized.

Parameters:


None.

Returns:
uint8_t Wiper0 data.

MCP41HV51_Wiper0Write()

void MCP41HV51_Wiper0Write (uint8_t data)

Writes to the SPI Digi POT MCP41HV51 Wiper0 register.

Precondition:
An SPI Host driver is generated, and SPI Digi POT MCP41HV51 is initialized.

Parameters:


uint8_t	data - Data to be written to the Wiper0 register.

Returns:
None.

MCP41HV51_Write()

void MCP41HV51_Write (uint8_t * buffer, uint8_t bufferSize)

Writes to the SPI Digi POT MCP41HV51.

Precondition:
An SPI Host driver is generated, and SPI Digi POT MCP41HV51 is initialized.

Parameters:


uint8_t	*buffer
uint8_t	bufferSize

Returns:
None.

2.8.2.1.3 Enumeration Type Documentation

mcp41hv51_cmd

enum mcp41hv51_cmd

SPI Digi POT MCP41HV51 Commands:


WRITE_DATA
INCREMENT_WIPER
DECREMENT_WIPER
READ_DATA

2.8.3 File Documentation

2.8.3.1 source/mcp41hv51.h File Reference

#include <stdint.h>

2.8.3.1.1 Functions

void MCP41HV51_Initialize (void)

Initializes the SPI Digi POT MCP41HV51.
void MCP41HV51_Wiper0Write (uint8_t data)

Writes to the SPI Digi POT MCP41HV51 Wiper0 register.
uint8_t MCP41HV51_Wiper0Read (void)

Reads from the SPI Digi POT MCP41HV51 Wiper0 register.
void MCP41HV51_Wiper0Increment (void)

Increments the SPI Digi POT MCP41HV51 Wiper0 register.
void MCP41HV51_Wiper0Decrement (void)

Decrements the SPI Digi POT MCP41HV51 Wiper0 register.
void MCP41HV51_TconRegWrite (uint8_t data)

Writes to the SPI Digi POT MCP41HV51 TCON register.
uint8_t MCP41HV51_TconRegRead (void)

Reads from the SPI Digi POT MCP41HV51 TCON register.
void MCP41HV51_Enable (void)

Enables the SPI Digi POT MCP41HV51.
void MCP41HV51_Disable (void)

Disables the SPI Digi POT MCP41HV51.
void MCP41HV51_HardwareShutdownEnable (void)

Forces the SPI Digi POT MCP41HV51 into Hardware Shutdown mode.
void MCP41HV51_HardwareShutdownDisable (void)

Removes the SPI Digi POT MCP41HV51 from Hardware Shutdown mode.

2.8.3.1.2 Detailed Description

SPI Digi POT MCP41HV51 Generated Driver Header File

2.8.3.2 source/mcp41hv51_config.h File Reference

This file provides configuration constants for the SPI Digi POT MCP41HV51 driver.

2.8.3.2.1 Macros

Register Setting Macros

SPI Digi POT MCP41HV51 register settings' addresses, bit masks and values:

#define MCP41HV51_ADDR_MASK 0xF0
#define MCP41HV51_CMD_MASK 0x0C
#define MCP41HV51_R0HW_MASK 0x08
#define MCP41HV51_TCON_ADDRESS 0x04
#define MCP41HV51_TCON_POR 0xFF
#define MCP41HV51_WIP0_ADDRESS 0x00
#define MCP41HV51_WIP0_POR 0x7F
#define MCP41HV51_SHUTDOWN_ENABLED 1
#define MCP41HV51_SHUTDOWN_DISABLED 1

2.8.3.2.2 Enumerations

enum mcp41hv51_cmd { WRITE_DATA, INCREMENT_WIPER, DECREMENT_WIPER, READ_DATA }

SPI Digi POT MCP41HV51 Commands:

2.8.3.2.3 Detailed Description

This file provides configuration constants for the SPI Digi POT MCP41HV51 driver.

SPI Digi POT MCP41HV51 Generated Driver Config Header File

Version: SPI Digi POT MCP41HV51 Driver Version 1.0.0

2.8.3.2.4 Macro Definition Documentation

MCP41HV51_ADDR_MASK

#define MCP41HV51_ADDR_MASK 0xF0

MCP41HV51_CMD_MASK

#define MCP41HV51_CMD_MASK 0x0C

MCP41HV51_R0HW_MASK

#define MCP41HV51_R0HW_MASK 0x08

MCP41HV51_SHUTDOWN_DISABLED

#define MCP41HV51_SHUTDOWN_DISABLED 1

MCP41HV51_SHUTDOWN_ENABLED

#define MCP41HV51_SHUTDOWN_ENABLED 1

MCP41HV51_TCON_ADDRESS

#define MCP41HV51_TCON_ADDRESS 0x04

MCP41HV51_TCON_POR

#define MCP41HV51_TCON_POR 0xFF

MCP41HV51_WIP0_ADDRESS

#define MCP41HV51_WIP0_ADDRESS 0x00

MCP41HV51_WIP0_POR

#define MCP41HV51_WIP0_POR 0x7F

2.8.3.3 source/src/mcp41hv51.c File Reference

This file provides APIs definitions for the SPI Digi POT MCP41HV51 driver.

#include "../../mcp41hv51-digipot/mcp41hv51.h"
#include "../../mcp41hv51-digipot/mcp41hv51_config.h"
#include "../../system/pins.h"
#include "../../spi/spi1.h"

2.8.3.3.1 Functions

void MCP41HV51_Write (uint8_t *buffer, uint8_t bufferSize)

Writes to the SPI Digi POT MCP41HV51.
void MCP41HV51_Read (uint8_t *buffer, uint8_t bufferSize)

Reads from the SPI Digi POT MCP41HV51.
void MCP41HV51_Initialize (void)

Initializes the SPI Digi POT MCP41HV51.
void MCP41HV51_Wiper0Write (uint8_t data)

Writes to the SPI Digi POT MCP41HV51 Wiper0 register.
uint8_t MCP41HV51_Wiper0Read (void)

Reads from the SPI Digi POT MCP41HV51 Wiper0 register.
void MCP41HV51_Wiper0Increment (void)

Increments the SPI Digi POT MCP41HV51 Wiper0 register.
void MCP41HV51_Wiper0Decrement (void)

Decrements the SPI Digi POT MCP41HV51 Wiper0 register.
void MCP41HV51_TconRegWrite (uint8_t data)

Writes to the SPI Digi POT MCP41HV51 TCON register.
uint8_t MCP41HV51_TconRegRead (void)

Reads from the SPI Digi POT MCP41HV51 TCON register.
void MCP41HV51_Enable (void)

Enables the SPI Digi POT MCP41HV51.
void MCP41HV51_Disable (void)

Disables the SPI Digi POT MCP41HV51.
void MCP41HV51_HardwareShutdownEnable (void)

Forces the SPI Digi POT MCP41HV51 into Hardware Shutdown mode.
void MCP41HV51_HardwareShutdownDisable (void)

Removes the SPI Digi POT MCP41HV51 from Hardware Shutdown mode.