Writing C# modules unlocks a lot of functionality in Renode, however it's very difficult to debug these modules.
For example, in this module:
using System;
using Antmicro.Renode.Core;
using Antmicro.Renode.Peripherals.Bus;
using Antmicro.Renode.Time;
using Antmicro.Renode.Logging;
using System.Threading;
namespace Antmicro.Renode.Peripherals.Timers
{
public class SimpleTicker : IDoubleWordPeripheral
{
public SimpleTicker(ulong periodInMs, Machine machine)
{
machine.ClockSource.AddClockEntry(new ClockEntry(periodInMs, ClockEntry.FrequencyToRatio(this, 1000), OnTick, this, String.Empty));
}
// ...
}
}It's difficult to know:
- What properties there are on
machine
- Where
Machine is defined (which package does it come from?)
- What do each of the parameters in that function mean?
- What is a
ClockSource and how does it work?
- What other properties are there in
Antmicro.Renode.Peripherals?
- What is the interface required to implement
IDoubleWordPeripheral?
- Does this even compile?
Many of these questions could be answered by connecting this .cs file to an IDE of some sort. I'm not sure how 2 could be answered, because I gather that's a feature of C#. 7 can only be answered by restarting Renode.
With C# modules being documented, it would also be nice to know how to implement modules and debug issues within them.
Writing C# modules unlocks a lot of functionality in Renode, however it's very difficult to debug these modules.
For example, in this module:
It's difficult to know:
machineMachineis defined (which package does it come from?)ClockSourceand how does it work?Antmicro.Renode.Peripherals?IDoubleWordPeripheral?Many of these questions could be answered by connecting this
.csfile to an IDE of some sort. I'm not sure how2could be answered, because I gather that's a feature of C#.7can only be answered by restarting Renode.With C# modules being documented, it would also be nice to know how to implement modules and debug issues within them.