c612b56bc1
codespell -q 3 --builtin=clear,rare,informal,code -S ./Marlin/src/lcd/language -L alo,amin,endcode,stdio,uint
155 lines
4.4 KiB
C++
155 lines
4.4 KiB
C++
/**
|
|
* Marlin 3D Printer Firmware
|
|
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
|
*
|
|
* Based on Sprinter and grbl.
|
|
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* mcp4728.cpp - Arduino library for MicroChip MCP4728 I2C D/A converter
|
|
*
|
|
* For implementation details, please take a look at the datasheet:
|
|
* https://ww1.microchip.com/downloads/en/DeviceDoc/22187a.pdf
|
|
*
|
|
* For discussion and feedback, please go to:
|
|
* https://forum.arduino.cc/index.php/topic,51842.0.html
|
|
*/
|
|
|
|
#include "../../inc/MarlinConfig.h"
|
|
|
|
#if HAS_MOTOR_CURRENT_DAC
|
|
|
|
#include "dac_mcp4728.h"
|
|
|
|
MCP4728 mcp4728;
|
|
|
|
xyze_uint_t dac_values;
|
|
|
|
/**
|
|
* Begin I2C, get current values (input register and eeprom) of mcp4728
|
|
*/
|
|
void MCP4728::init() {
|
|
Wire.begin();
|
|
Wire.requestFrom(I2C_ADDRESS(DAC_DEV_ADDRESS), uint8_t(24));
|
|
while (Wire.available()) {
|
|
char deviceID = Wire.read(),
|
|
hiByte = Wire.read(),
|
|
loByte = Wire.read();
|
|
|
|
if (!(deviceID & 0x08))
|
|
dac_values[(deviceID & 0x30) >> 4] = word((hiByte & 0x0F), loByte);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Write input resister value to specified channel using fastwrite method.
|
|
* Channel : 0-3, Values : 0-4095
|
|
*/
|
|
uint8_t MCP4728::analogWrite(const uint8_t channel, const uint16_t value) {
|
|
dac_values[channel] = value;
|
|
return fastWrite();
|
|
}
|
|
|
|
/**
|
|
* Write all input resistor values to EEPROM using SequentialWrite method.
|
|
* This will update both input register and EEPROM value
|
|
* This will also write current Vref, PowerDown, Gain settings to EEPROM
|
|
*/
|
|
uint8_t MCP4728::eepromWrite() {
|
|
Wire.beginTransmission(I2C_ADDRESS(DAC_DEV_ADDRESS));
|
|
Wire.write(SEQWRITE);
|
|
LOOP_LOGICAL_AXES(i) {
|
|
Wire.write(DAC_STEPPER_VREF << 7 | DAC_STEPPER_GAIN << 4 | highByte(dac_values[i]));
|
|
Wire.write(lowByte(dac_values[i]));
|
|
}
|
|
return Wire.endTransmission();
|
|
}
|
|
|
|
/**
|
|
* Write Voltage reference setting to all input registers
|
|
*/
|
|
uint8_t MCP4728::setVref_all(const uint8_t value) {
|
|
Wire.beginTransmission(I2C_ADDRESS(DAC_DEV_ADDRESS));
|
|
Wire.write(VREFWRITE | (value ? 0x0F : 0x00));
|
|
return Wire.endTransmission();
|
|
}
|
|
/**
|
|
* Write Gain setting to all input registers
|
|
*/
|
|
uint8_t MCP4728::setGain_all(const uint8_t value) {
|
|
Wire.beginTransmission(I2C_ADDRESS(DAC_DEV_ADDRESS));
|
|
Wire.write(GAINWRITE | (value ? 0x0F : 0x00));
|
|
return Wire.endTransmission();
|
|
}
|
|
|
|
/**
|
|
* Return Input Register value
|
|
*/
|
|
uint16_t MCP4728::getValue(const uint8_t channel) { return dac_values[channel]; }
|
|
|
|
#if 0
|
|
/**
|
|
* Steph: Might be useful in the future
|
|
* Return Vout
|
|
*/
|
|
uint16_t MCP4728::getVout(const uint8_t channel) {
|
|
const uint32_t vref = 2048,
|
|
vOut = (vref * dac_values[channel] * (_DAC_STEPPER_GAIN + 1)) / 4096;
|
|
return _MIN(vOut, defaultVDD);
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* Returns DAC values as a 0-100 percentage of drive strength
|
|
*/
|
|
uint8_t MCP4728::getDrvPct(const uint8_t channel) { return uint8_t(100.0 * dac_values[channel] / (DAC_STEPPER_MAX) + 0.5); }
|
|
|
|
/**
|
|
* Receives all Drive strengths as 0-100 percent values, updates
|
|
* DAC Values array and calls fastwrite to update the DAC.
|
|
*/
|
|
void MCP4728::setDrvPct(xyze_uint_t &pct) {
|
|
dac_values = pct * (DAC_STEPPER_MAX) * 0.01f;
|
|
fastWrite();
|
|
}
|
|
|
|
/**
|
|
* FastWrite input register values - All DAC output update. refer to DATASHEET 5.6.1
|
|
* DAC Input and PowerDown bits update.
|
|
* No EEPROM update
|
|
*/
|
|
uint8_t MCP4728::fastWrite() {
|
|
Wire.beginTransmission(I2C_ADDRESS(DAC_DEV_ADDRESS));
|
|
LOOP_LOGICAL_AXES(i) {
|
|
Wire.write(highByte(dac_values[i]));
|
|
Wire.write(lowByte(dac_values[i]));
|
|
}
|
|
return Wire.endTransmission();
|
|
}
|
|
|
|
/**
|
|
* Common function for simple general commands
|
|
*/
|
|
uint8_t MCP4728::simpleCommand(const byte simpleCommand) {
|
|
Wire.beginTransmission(I2C_ADDRESS(GENERALCALL));
|
|
Wire.write(simpleCommand);
|
|
return Wire.endTransmission();
|
|
}
|
|
|
|
#endif // HAS_MOTOR_CURRENT_DAC
|