andreil/klipper
1
0
Fork 0
mirror of https://github.com/andreili/klipper.git synced 2025-08-24 03:44:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

tmc5160: Rename registers to Registers and fields to Fields

Browse Source 
Minor change to the code so that it is more similar to the other tmc
drivers.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2019-06-05 19:34:18 -04:00 committed by KevinOConnor
parent 5de9f74525
commit 2b0251ee99
1 changed files with 87 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
klippy/extras/tmc5160.py
View File

@ -10,7 +10,7 @@ vsense = 0.325
GLOBAL_SCALER = 256 GLOBAL_SCALER = 256
TMC_FREQUENCY=12000000. TMC_FREQUENCY=12000000.
registers = { Registers = {
"GCONF": 0x00, "GCONF": 0x00,
"GSTAT": 0x01, "GSTAT": 0x01,
"IFCNT": 0x02, "IFCNT": 0x02,
@ -71,7 +71,7 @@ registers = {
"PWMCONF": 0x70, "PWMCONF": 0x70,
"PWM_SCALE": 0x71, "PWM_SCALE": 0x71,
"PWM_AUTO": 0x72, "PWM_AUTO": 0x72,
"LOST_STEPS": 0x73 "LOST_STEPS": 0x73,
} }
ReadRegisters = [ ReadRegisters = [
@ -80,8 +80,8 @@ ReadRegisters = [
"PWM_AUTO", "TSTEP" "PWM_AUTO", "TSTEP"
] ]
fields = {} Fields = {}
fields["COOLCONF"] = { Fields["COOLCONF"] = {
"semin": 0x0F << 0, "semin": 0x0F << 0,
"seup": 0x03 << 5, "seup": 0x03 << 5,
"semax": 0x0F << 8, "semax": 0x0F << 8,
@ -90,7 +90,7 @@ fields["COOLCONF"] = {
"sgt": 0x7F << 16, "sgt": 0x7F << 16,
"sfilt": 0x01 << 24 "sfilt": 0x01 << 24
} }
fields["CHOPCONF"] = { Fields["CHOPCONF"] = {
"toff": 0x0F << 0, "toff": 0x0F << 0,
"hstrt": 0x07 << 4, "hstrt": 0x07 << 4,
"hend": 0x0F << 7, "hend": 0x0F << 7,
@ -107,7 +107,7 @@ fields["CHOPCONF"] = {
"diss2g": 0x01 << 30, "diss2g": 0x01 << 30,
"diss2vs": 0x01 << 31 "diss2vs": 0x01 << 31
} }
fields["DRV_STATUS"] = { Fields["DRV_STATUS"] = {
"SG_RESULT": 0x3FF << 0, "SG_RESULT": 0x3FF << 0,
"s2vsa": 0x01 << 12, "s2vsa": 0x01 << 12,
"s2vsb": 0x01 << 13, "s2vsb": 0x01 << 13,
@ -123,10 +123,10 @@ fields["DRV_STATUS"] = {
"olb": 0x01 << 30, "olb": 0x01 << 30,
"stst": 0x01 << 31 "stst": 0x01 << 31
} }
fields["FACTORY_CONF"] = { Fields["FACTORY_CONF"] = {
"FACTORY_CONF": 0x1F << 0 "FACTORY_CONF": 0x1F << 0
} }
fields["GCONF"] = { Fields["GCONF"] = {
"recalibrate": 0x01 << 0, "recalibrate": 0x01 << 0,
"faststandstill": 0x01 << 1, "faststandstill": 0x01 << 1,
"en_pwm_mode": 0x01 << 2, "en_pwm_mode": 0x01 << 2,
@ -146,17 +146,17 @@ fields["GCONF"] = {
"direct_mode": 0x01 << 16, "direct_mode": 0x01 << 16,
"test_mode": 0x01 << 17 "test_mode": 0x01 << 17
} }
fields["GSTAT"] = { Fields["GSTAT"] = {
"reset": 0x01 << 0, "reset": 0x01 << 0,
"drv_err": 0x01 << 1, "drv_err": 0x01 << 1,
"uv_cp": 0x01 << 2 "uv_cp": 0x01 << 2
} }
fields["IHOLD_IRUN"] = { Fields["IHOLD_IRUN"] = {
"IHOLD": 0x1F << 0, "IHOLD": 0x1F << 0,
"IRUN": 0x1F << 8, "IRUN": 0x1F << 8,
"IHOLDDELAY": 0x0F << 16 "IHOLDDELAY": 0x0F << 16
} }
fields["IOIN"] = { Fields["IOIN"] = {
"REFL_STEP": 0x01 << 0, "REFL_STEP": 0x01 << 0,
"REFR_DIR": 0x01 << 1, "REFR_DIR": 0x01 << 1,
"ENCB_DCEN_CFG4": 0x01 << 2, "ENCB_DCEN_CFG4": 0x01 << 2,
@ -167,27 +167,27 @@ fields["IOIN"] = {
"SWCOMP_IN": 0x01 << 7, "SWCOMP_IN": 0x01 << 7,
"VERSION": 0xFF << 24 "VERSION": 0xFF << 24
} }
fields["LOST_STEPS"] = { Fields["LOST_STEPS"] = {
"LOST_STEPS": 0xfffff << 0 "LOST_STEPS": 0xfffff << 0
} }
fields["MSCNT"] = { Fields["MSCNT"] = {
"MSCNT": 0x3ff << 0 "MSCNT": 0x3ff << 0
} }
fields["MSCURACT"] = { Fields["MSCURACT"] = {
"CUR_A": 0x1ff << 0, "CUR_A": 0x1ff << 0,
"CUR_B": 0x1ff << 16 "CUR_B": 0x1ff << 16
} }
fields["OTP_READ"] = { Fields["OTP_READ"] = {
"OTP_FCLKTRIM": 0x1f << 0, "OTP_FCLKTRIM": 0x1f << 0,
"otp_S2_LEVEL": 0x01 << 5, "otp_S2_LEVEL": 0x01 << 5,
"otp_BBM": 0x01 << 6, "otp_BBM": 0x01 << 6,
"otp_TBL": 0x01 << 7 "otp_TBL": 0x01 << 7
} }
fields["PWM_AUTO"] = { Fields["PWM_AUTO"] = {
"PWM_OFS_AUTO": 0xff << 0, "PWM_OFS_AUTO": 0xff << 0,
"PWM_GRAD_AUTO": 0xff << 16 "PWM_GRAD_AUTO": 0xff << 16
} }
fields["PWMCONF"] = { Fields["PWMCONF"] = {
"PWM_OFS": 0xFF << 0, "PWM_OFS": 0xFF << 0,
"PWM_GRAD": 0xFF << 8, "PWM_GRAD": 0xFF << 8,
"pwm_freq": 0x03 << 16, "pwm_freq": 0x03 << 16,
@ -197,17 +197,17 @@ fields["PWMCONF"] = {
"PWM_REG": 0x0F << 24, "PWM_REG": 0x0F << 24,
"PWM_LIM": 0x0F << 28 "PWM_LIM": 0x0F << 28
} }
fields["PWM_SCALE"] = { Fields["PWM_SCALE"] = {
"PWM_SCALE_SUM": 0xff << 0, "PWM_SCALE_SUM": 0xff << 0,
"PWM_SCALE_AUTO": 0x1ff << 16 "PWM_SCALE_AUTO": 0x1ff << 16
} }
fields["TPOWERDOWN"] = { Fields["TPOWERDOWN"] = {
"TPOWERDOWN": 0xff << 0 "TPOWERDOWN": 0xff << 0
} }
fields["TPWMTHRS"] = { Fields["TPWMTHRS"] = {
"TPWMTHRS": 0xfffff << 0 "TPWMTHRS": 0xfffff << 0
} }
fields["TSTEP"] = { Fields["TSTEP"] = {
"TSTEP": 0xfffff << 0 "TSTEP": 0xfffff << 0
} }
@ -275,7 +275,7 @@ class TMC5160:
self.cmd_INIT_TMC, desc=self.cmd_INIT_TMC_help) self.cmd_INIT_TMC, desc=self.cmd_INIT_TMC_help)
# Setup basic register values # Setup basic register values
self.regs = collections.OrderedDict() self.regs = collections.OrderedDict()
self.fields = tmc2130.FieldHelper(fields, SignedFields, FieldFormatters, self.fields = tmc2130.FieldHelper(Fields, SignedFields, FieldFormatters,
self.regs) self.regs)
irun, ihold, self.sense_resistor = get_config_current(config) irun, ihold, self.sense_resistor = get_config_current(config)
msteps, en_pwm, thresh = \ msteps, en_pwm, thresh = \
@ -328,12 +328,12 @@ class TMC5160:
self._init_registers() self._init_registers()
def decode_hex(self, hex_, reg_name=False): def decode_hex(self, hex_, reg_name=False):
reg = int( (hex_ >> 32) & 0xff - long(0x80) ) reg = int( (hex_ >> 32) & 0xff - long(0x80) )
if reg not in registers.values(): if reg not in Registers.values():
reg = int( (hex_ >> 32) & 0xff ) reg = int( (hex_ >> 32) & 0xff )
if reg not in registers.values(): if reg not in Registers.values():
reg_name = "UFO" reg_name = "UFO"
if not reg_name: if not reg_name:
for name, adr_ in registers.items(): for name, adr_ in Registers.items():
if adr_ == reg: if adr_ == reg:
reg_name = name reg_name = name
val = hex_ & 0xFFFFFFFF val = hex_ & 0xFFFFFFFF
@ -348,7 +348,7 @@ class TMC5160:
raise pins.error("Can not pullup/invert tmc5160 virtual endstop") raise pins.error("Can not pullup/invert tmc5160 virtual endstop")
return tmc2130.TMC2130VirtualEndstop(self) return tmc2130.TMC2130VirtualEndstop(self)
def get_register(self, reg_name): def get_register(self, reg_name):
reg = registers[reg_name] reg = Registers[reg_name]
self.spi.spi_send([reg, 0x00, 0x00, 0x00, 0x00]) self.spi.spi_send([reg, 0x00, 0x00, 0x00, 0x00])
if self.printer.get_start_args().get('debugoutput') is not None: if self.printer.get_start_args().get('debugoutput') is not None:
return 0 return 0
@ -356,7 +356,7 @@ class TMC5160:
pr = bytearray(params['response']) pr = bytearray(params['response'])
return (pr[1] << 24) | (pr[2] << 16) | (pr[3] << 8) | pr[4] return (pr[1] << 24) | (pr[2] << 16) | (pr[3] << 8) | pr[4]
def set_register(self, reg_name, val, min_clock = 0): def set_register(self, reg_name, val, min_clock = 0):
reg = registers[reg_name] reg = Registers[reg_name]
data = [(reg | 0x80) & 0xff, (val >> 24) & 0xff, (val >> 16) & 0xff, data = [(reg | 0x80) & 0xff, (val >> 24) & 0xff, (val >> 16) & 0xff,
(val >> 8) & 0xff, val & 0xff] (val >> 8) & 0xff, val & 0xff]
self.decode_hex( val, reg_name=reg_name ) self.decode_hex( val, reg_name=reg_name )