Skip to content

Omit mask name suffix from firmware group masks #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
glopesdev merged 1 commit into from
Mar 22, 2026
Merged

Omit mask name suffix from firmware group masks #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/AppFuncs.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<#
foreach (var registerMetadata in DeviceMetadata.Registers)
{
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
#>
void app_read_REG_<#= registerName #>(void);
<#
Expand All @@ -41,7 +41,7 @@ void app_read_REG_<#= registerName #>(void);
<#
foreach (var registerMetadata in DeviceMetadata.Registers)
{
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
#>
bool app_write_REG_<#= registerName #>(void *a);
<#
Expand Down
6 changes: 3 additions & 3 deletions src/AppFuncsImpl.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ void (*app_func_rd_pointer[])(void) = {
registerIndex = 0;
foreach (var registerMetadata in deviceRegisters)
{
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
#>
&app_read_REG_<#= registerName #><#= ++registerIndex < deviceRegisters.Count ? "," : string.Empty #>
<#
Expand All @@ -38,7 +38,7 @@ bool (*app_func_wr_pointer[])(void*) = {
registerIndex = 0;
foreach (var registerMetadata in deviceRegisters)
{
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
#>
&app_write_REG_<#= registerName #><#= ++registerIndex < deviceRegisters.Count ? "," : string.Empty #>
<#
Expand All @@ -49,7 +49,7 @@ foreach (var registerMetadata in deviceRegisters)
foreach (var registerMetadata in deviceRegisters)
{
var register = registerMetadata.Value;
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
var firmwareType = TemplateHelper.GetFirmwareType(register.Type);
var allowWrite = (register.Access & RegisterAccess.Write) != 0;
var isArrayRegister = register.Length > 0;
Expand Down
44 changes: 18 additions & 26 deletions src/AppRegs.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ int totalRegisterSize = 0;
foreach (var registerMetadata in DeviceMetadata.Registers)
{
var register = registerMetadata.Value;
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
maxRegisterNameLength = Math.Max(maxRegisterNameLength, registerName.Length);
minRegisterAddress = Math.Min(minRegisterAddress, register.Address);
maxRegisterAddress = Math.Max(maxRegisterAddress, register.Address);
Expand All @@ -33,8 +33,8 @@ foreach (var registerMetadata in DeviceMetadata.Registers)
void init_ios(void);
<#
var maxPinNameLength = Math.Max(
inputPins.Count > 0 ? inputPins.Max(pin => FirmwareNamingConvention.Instance.Apply(pin.Key).Length) : 0,
outputPins.Count > 0 ? outputPins.Max(pin => FirmwareNamingConvention.Instance.Apply(pin.Key).Length) : 0);
inputPins.Count > 0 ? inputPins.Max(pin => TemplateHelper.GetFirmwareName(pin.Key).Length) : 0,
outputPins.Count > 0 ? outputPins.Max(pin => TemplateHelper.GetFirmwareName(pin.Key).Length) : 0);
if (inputPins.Count > 0)
{
#>
Expand All @@ -44,7 +44,7 @@ if (inputPins.Count > 0)
<#
foreach (var pin in inputPins)
{
var pinName = FirmwareNamingConvention.Instance.Apply(pin.Key);
var pinName = TemplateHelper.GetFirmwareName(pin.Key);
var descriptionOffset = maxPinNameLength - pinName.Length + 10;
#>
// <#= pinName #><#= new string(' ', descriptionOffset) #>Description: <#= pin.Value.Description #>
Expand All @@ -56,7 +56,7 @@ if (inputPins.Count > 0)
foreach (var pin in inputPins)
{
var pinInfo = pin.Value;
var pinName = FirmwareNamingConvention.Instance.Apply(pin.Key);
var pinName = TemplateHelper.GetFirmwareName(pin.Key);
var nameOffset = maxPinNameLength - pinName.Length + 4;
#>
#define read_<#= pinName #> read_io(<#= pinInfo.Port #>, <#= pinInfo.PinNumber #>)<#= new string(' ', nameOffset) #>// <#= pinName #>
Expand All @@ -77,7 +77,7 @@ if (outputPins.Count > 0)
<#
foreach (var pin in outputPins)
{
var pinName = FirmwareNamingConvention.Instance.Apply(pin.Key);
var pinName = TemplateHelper.GetFirmwareName(pin.Key);
var descriptionOffset = maxPinNameLength - pinName.Length + 10;
#>
// <#= pinName #><#= new string(' ', descriptionOffset) #>Description: <#= pin.Value.Description #>
Expand All @@ -88,7 +88,7 @@ if (outputPins.Count > 0)
foreach (var pin in outputPins)
{
var pinInfo = pin.Value;
var pinName = FirmwareNamingConvention.Instance.Apply(pin.Key);
var pinName = TemplateHelper.GetFirmwareName(pin.Key);
var setFunc = pinInfo.Invert ? "clear_io" : "set_io";
var clrFunc = pinInfo.Invert ? "set_io" : "clear_io";
#>
Expand All @@ -114,7 +114,7 @@ typedef struct
foreach (var registerMetadata in DeviceMetadata.Registers)
{
var register = registerMetadata.Value;
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
var arrayType = register.Length > 0 ? $"[{register.Length}]" : string.Empty;
var firmwareType = TemplateHelper.GetFirmwareType(register.Type);
#>
Expand All @@ -133,7 +133,7 @@ foreach (var registerMetadata in DeviceMetadata.Registers)
{
var register = registerMetadata.Value;
var registerAddress = register.Address.ToString();
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
var registerType = TemplateHelper.GetFirmwareRegisterType(register.Type);
var addressOffset = new string(' ', maxRegisterNameLength - registerName.Length - registerAddress.Length + 6);
var descriptionOffset = new string(' ', 7 - registerType.Length);
Expand All @@ -158,25 +158,17 @@ foreach (var registerMetadata in DeviceMetadata.Registers)
/* Registers' bits */
/************************************************************************/
<#
var maxBitNameLength = DeviceMetadata.BitMasks.Values
.SelectMany(mask => mask.Bits)
.Select(bitField => FirmwareNamingConvention.Instance.Apply(bitField.Key).Length)
.Prepend(0).Max();
var maxMemberNameLength = (from groupMask in DeviceMetadata.GroupMasks
let maskName = FirmwareGroupMaskNamingConvention.Instance.Apply(groupMask.Key)
from member in groupMask.Value.Values
let memberName = FirmwareNamingConvention.Instance.Apply(member.Key)
select maskName.Length + memberName.Length)
.Prepend(0).Max();
var maxBitMemberNameLength = Math.Max(maxBitNameLength, maxMemberNameLength);
var maxBitMaskNameLength = TemplateHelper.GetMaxFirmwareBitMaskNameLength(DeviceMetadata);
var maxGroupMaskNameLength = TemplateHelper.GetMaxFirmwareGroupMaskNameLength(DeviceMetadata);
var maxMaskNameLength = Math.Max(maxBitMaskNameLength, maxGroupMaskNameLength);
foreach (var bitMask in DeviceMetadata.BitMasks)
{
var mask = bitMask.Value;
foreach (var bitField in mask.Bits)
{
var fieldInfo = bitField.Value;
var fieldName = FirmwareNamingConvention.Instance.Apply(bitField.Key);
var fieldNamePadding = new string(' ', maxBitMemberNameLength - fieldName.Length + 6);
var fieldName = TemplateHelper.GetFirmwareName(bitField.Key);
var fieldNamePadding = new string(' ', maxMaskNameLength - fieldName.Length + 6);
var bitShift = (int)Math.Log(fieldInfo.Value, 2);
var bitShiftPadding = new string(' ', 8 - bitShift.ToString().Length);
#>
Expand All @@ -190,8 +182,8 @@ foreach (var groupMask in DeviceMetadata.GroupMasks)
{
var mask = groupMask.Value;
var maskSelect = TemplateHelper.GetMaskSelect(mask).ToString("X2");
var maskName = FirmwareGroupMaskNamingConvention.Instance.Apply(groupMask.Key);
var maskNamePadding = new string(' ', maxBitMemberNameLength - maskName.Length);
var maskName = TemplateHelper.GetFirmwareGroupMaskName(groupMask.Key);
var maskNamePadding = new string(' ', maxMaskNameLength - maskName.Length);
var maskSelectPadding = new string(' ', 11 - maskSelect.Length);
#>
#define MSK_<#= maskName #>_SEL<#= maskNamePadding #>0x<#= maskSelect #><#= maskSelectPadding #>//
Expand All @@ -200,8 +192,8 @@ foreach (var groupMask in DeviceMetadata.GroupMasks)
foreach (var member in mask.Values)
{
var memberInfo = member.Value;
var memberName = FirmwareNamingConvention.Instance.Apply(member.Key);
var memberNamePadding = new string(' ', maxBitMemberNameLength - memberName.Length - maskName.Length + 4);
var memberName = TemplateHelper.GetFirmwareName(member.Key);
var memberNamePadding = new string(' ', maxMaskNameLength - memberName.Length - maskName.Length + 4);
var memberHexValue = memberInfo.Value.ToString("X2");
var memberHexPadding = new string(' ', 11 - memberHexValue.Length);
#>
Expand Down
16 changes: 8 additions & 8 deletions src/AppRegsImpl.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ int totalRegisterSize = 0;
foreach (var registerMetadata in deviceRegisters)
{
var register = registerMetadata.Value;
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
maxRegisterNameLength = Math.Max(maxRegisterNameLength, registerName.Length);
minRegisterAddress = Math.Min(minRegisterAddress, register.Address);
maxRegisterAddress = Math.Max(maxRegisterAddress, register.Address);
Expand All @@ -40,8 +40,8 @@ foreach (var registerMetadata in deviceRegisters)
void init_ios(void)
{<#
var maxPinNameLength = Math.Max(
inputPins.Count > 0 ? inputPins.Max(pin => FirmwareNamingConvention.Instance.Apply(pin.Key).Length) : 0,
outputPins.Count > 0 ? outputPins.Max(pin => FirmwareNamingConvention.Instance.Apply(pin.Key).Length) : 0);
inputPins.Count > 0 ? inputPins.Max(pin => TemplateHelper.GetFirmwareName(pin.Key).Length) : 0,
outputPins.Count > 0 ? outputPins.Max(pin => TemplateHelper.GetFirmwareName(pin.Key).Length) : 0);
if (inputPins.Count > 0)
{
#>
Expand All @@ -51,7 +51,7 @@ if (inputPins.Count > 0)
foreach (var pin in inputPins)
{
var pinInfo = pin.Value;
var pinName = FirmwareNamingConvention.Instance.Apply(pin.Key);
var pinName = TemplateHelper.GetFirmwareName(pin.Key);
var pullMode = TemplateHelper.GetFirmwarePullMode(pinInfo.PinMode);
var senseMode = TemplateHelper.GetFirmwareSenseMode(pinInfo.TriggerMode);
var descriptionPadding = new string(' ', 49 - pinInfo.Port.Length - pullMode.Length - senseMode.Length);
Expand All @@ -72,7 +72,7 @@ if (inputPins.Count > 0)
var pinInfo = pin.Value;
var port = pinInfo.Port;
var pinNumber = pinInfo.PinNumber.ToString();
var pinName = FirmwareNamingConvention.Instance.Apply(pin.Key);
var pinName = TemplateHelper.GetFirmwareName(pin.Key);
if (!pinInfo.InterruptNumber.HasValue)
Error($"({pinName}) Interrupt number must be specified if interrupt priority is set.");
var interruptNumber = pinInfo.InterruptNumber.GetValueOrDefault();
Expand All @@ -94,7 +94,7 @@ if (outputPins.Count > 0)
foreach (var pin in outputPins)
{
var pinInfo = pin.Value;
var pinName = FirmwareNamingConvention.Instance.Apply(pin.Key);
var pinName = TemplateHelper.GetFirmwareName(pin.Key);
var descriptionOffset = maxPinNameLength - pinName.Length + 10;
var inputEnable = pinInfo.AllowRead ? "IN_EN_IO_EN" : "IN_EN_IO_DIS";
var outMode = TemplateHelper.GetFirmwareOutputIO(pinInfo.PinMode);
Expand All @@ -110,7 +110,7 @@ if (outputPins.Count > 0)
}
foreach (var pin in outputPins)
{
var pinName = FirmwareNamingConvention.Instance.Apply(pin.Key);
var pinName = TemplateHelper.GetFirmwareName(pin.Key);
var pinState = pin.Value.InitialState > 0 ? "set" : "clr";
#>
<#= pinState #>_<#= pinName #>;
Expand Down Expand Up @@ -154,7 +154,7 @@ uint8_t *app_regs_pointer[] = {
registerIndex = 0;
foreach (var registerMetadata in deviceRegisters)
{
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerName = TemplateHelper.GetFirmwareName(registerMetadata.Key);
#>
(uint8_t*)(&app_regs.REG_<#= registerName #>)<#= ++registerIndex < deviceRegisters.Count ? "," : string.Empty #>
<#
Expand Down
31 changes: 31 additions & 0 deletions src/Firmware.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,37 @@ public static string GetFirmwareType(PayloadType payloadType)
};
}

public static string GetFirmwareName(string value)
{
return FirmwareNamingConvention.Instance.Apply(value);
}

public static string GetFirmwareGroupMaskName(string value)
{
var suffixIndex = value.LastIndexOf("Mask");
if (suffixIndex >= 1)
value = value.Substring(0, suffixIndex);
return GetFirmwareName(value);
}

public static int GetMaxFirmwareBitMaskNameLength(DeviceInfo deviceMetadata)
{
return deviceMetadata.BitMasks.Values
.SelectMany(mask => mask.Bits)
.Select(bitField => GetFirmwareName(bitField.Key).Length)
.Prepend(0).Max();
}

public static int GetMaxFirmwareGroupMaskNameLength(DeviceInfo deviceMetadata)
{
return (from groupMask in deviceMetadata.GroupMasks
let maskName = GetFirmwareGroupMaskName(groupMask.Key)
from member in groupMask.Value.Values
let memberName = GetFirmwareName(member.Key)
select maskName.Length + memberName.Length)
.Prepend(0).Max();
}

public static string GetFirmwareRegisterType(PayloadType payloadType)
{
return payloadType switch
Expand Down
2 changes: 1 addition & 1 deletion src/Interrupts.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var interruptPins = TemplateHelper.GetPortPinsOfType<InputPinInfo>(PortPinMetada
foreach (var pin in interruptPins)
{
var pinInfo = pin.Value;
var pinName = FirmwareNamingConvention.Instance.Apply(pin.Key);
var pinName = TemplateHelper.GetFirmwareName(pin.Key);
if (!pinInfo.InterruptNumber.HasValue)
Error($"({pinName}) Interrupt number must be specified if interrupt priority is set.");
var interruptNumber = pinInfo.InterruptNumber.GetValueOrDefault();
Expand Down
23 changes: 21 additions & 2 deletions tests/ExpectedOutput/device.app_funcs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ void (*app_func_rd_pointer[])(void) = {
&app_read_REG_PULSE_DO_PORT0,
&app_read_REG_PULSE_DO0,
&app_read_REG_START_PULSE,
&app_read_REG_START_PULSE_TRAIN
&app_read_REG_START_PULSE_TRAIN,
&app_read_REG_ENCODER_MODE
};

bool (*app_func_wr_pointer[])(void*) = {
Expand All @@ -39,7 +40,8 @@ bool (*app_func_wr_pointer[])(void*) = {
&app_write_REG_PULSE_DO_PORT0,
&app_write_REG_PULSE_DO0,
&app_write_REG_START_PULSE,
&app_write_REG_START_PULSE_TRAIN
&app_write_REG_START_PULSE_TRAIN,
&app_write_REG_ENCODER_MODE
};

/************************************************************************/
Expand Down Expand Up @@ -244,3 +246,20 @@ bool app_write_REG_START_PULSE_TRAIN(void *a)
app_regs.REG_START_PULSE_TRAIN[0] = reg[0];
return true;
}

/************************************************************************/
/* REG_ENCODER_MODE */
/************************************************************************/
void app_read_REG_ENCODER_MODE(void)
{
//app_regs.REG_ENCODER_MODE = 0;

}

bool app_write_REG_ENCODER_MODE(void *a)
{
uint8_t reg = *((uint8_t*)a);

app_regs.REG_ENCODER_MODE = reg;
return true;
}
2 changes: 2 additions & 0 deletions tests/ExpectedOutput/device.app_funcs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ void app_read_REG_PULSE_DO_PORT0(void);
void app_read_REG_PULSE_DO0(void);
void app_read_REG_START_PULSE(void);
void app_read_REG_START_PULSE_TRAIN(void);
void app_read_REG_ENCODER_MODE(void);

bool app_write_REG_DIGITAL_INPUTS(void *a);
bool app_write_REG_ANALOG_DATA(void *a);
Expand All @@ -49,6 +50,7 @@ bool app_write_REG_PULSE_DO_PORT0(void *a);
bool app_write_REG_PULSE_DO0(void *a);
bool app_write_REG_START_PULSE(void *a);
bool app_write_REG_START_PULSE_TRAIN(void *a);
bool app_write_REG_ENCODER_MODE(void *a);


#endif /* _APP_FUNCTIONS_H_ */
9 changes: 6 additions & 3 deletions tests/ExpectedOutput/device.app_ios_and_regs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ uint8_t app_regs_type[] = {
TYPE_U16,
TYPE_U16,
TYPE_U16,
TYPE_U16
TYPE_U16,
TYPE_U8
};

uint16_t app_regs_n_elements[] = {
Expand All @@ -94,7 +95,8 @@ uint16_t app_regs_n_elements[] = {
1,
1,
1,
2
2,
1
};

uint8_t *app_regs_pointer[] = {
Expand All @@ -111,5 +113,6 @@ uint8_t *app_regs_pointer[] = {
(uint8_t*)(&app_regs.REG_PULSE_DO_PORT0),
(uint8_t*)(&app_regs.REG_PULSE_DO0),
(uint8_t*)(&app_regs.REG_START_PULSE),
(uint8_t*)(&app_regs.REG_START_PULSE_TRAIN)
(uint8_t*)(&app_regs.REG_START_PULSE_TRAIN),
(uint8_t*)(&app_regs.REG_ENCODER_MODE)
};
Loading
Loading