Chapter 1 Example 1: algorithm, architecture, and adequation

1.1 The main algorithm

Figure 1.1: Algorithm / New Algorithm Window

From the principal window, choose the File / Save as option and save your first application under a new folder (e.g. my_tutorial) with the name example1.

Choose Algorithm / New Algorithm Window (cf. figure 1.1). It opens the edition window for algorithm definitions.

1.1.1 Definition of a sensor

Figure 1.2: Define Sensor

Figure 1.3: Name of the new sensor

Figure 1.4: Sensor definition window

Figure 1.5: Contextual menu → Add port

Figure 1.6: Create Port

Figure 1.7: Sensor definition window after output port created

To create an input sensor definition:

from the algorithm window, click on the + green button. It opens a dialog window, check Sensor (cf. figure 1.2). Type the sensor name and optionally a list of parameters for the sensor. For example type input, then click OK (cf. figure 1.3). It creates the definition of the input sensor. To open it in definition mode, double click on input in the Definition list (cf. figure 1.4);
in input definition mode, right click on the background and select Add port (cf. figure 1.5). It opens a dialog window for the port’s direction, type, name and optionally its size. For example type ! int o, then click OK (cf. figure 1.6). It creates the integer output port o (cf. figure 1.7) in the sensor definition window.

1.1.2 Definition of an actuator

To create an output actuator definition:

from the algorithm window, click on the + green button → dialog window: check Actuator then type output and click OK;
double click on output in the Definition list. Then right click on its background and select Add port → dialog window: ? int i. Click OK. It creates the integer input port i in the sensor definition window.

1.1.3 Definition of a function

To create a computation function definition:

from the algorithm window, click on the + green button → dialog window: check Function then type computation and click OK;
double click on computation in the Definition list. Thenright click on its background and select Add port → dialog window: ? int a ? int b ! int o. Click OK. It creates the integer ports a, b, and o in the function definition window.

1.1.4 Definition of the main algorithm

Figure 1.8: Contextual menu → Set As Main Definition

Figure 1.9: Drag and drop input definition

Figure 1.10: Create References to input

Figure 1.11: Main algorithm after references to sensor created

Figure 1.12: Main algorithm of the Example 1

To create an AlgorithmMain function definition:

from the algorithm window, click on the + green button → dialog window: check Function then type AlgorithmMain and click OK;
double click on AlgorithmMain in the Definition list. Then right click on its background and select Set As Main Definition (cf. figure 1.8);
in its definition mode,
- to create references to the sensor input, drag and drop the sensor definition from the Definition list to the AlgorithmMain definition window (cf. figure 1.9) → dialog window: in1 in2 (cf. figure 1.10). The main algorithm looks like the figure 1.11,
- to create references to the actuator output, drag and drop the actuator definition from the Definition list to the AlgorithmMain definition window → dialog window: out1 out2 out3,
- to create a reference to the function computation, drag and drop its definition → dialog window: calc,
- from the AlgorithmMain definition window, to create a data dependence between in1 and calc, point the cursor on the output port o of the in1 operation, middle click, and drag to the input port a of the calc operation. It draws an arrow between these target ports. After creating the other data dependences, the main algorithm looks like the figure 1.12.

1.2 An architecture with one operator

1.2.1 Definition of an operator

Figure 1.13: Operator definition window

To create an Uinout operator definition:

from the principal window, choose Architecture / Define Operator. It opens a dialog window, type Uinout and click OK. It opens the operator definition window (cf. figure 1.13);
from the Uinout definition window:
- to add a gate: click Modify gates → dialog window: gate_type_1 x,
- to set the operator execution durations: click Modify durations → dialog window:
```
      
	computation = 2
	input = 1
	output = 3
      
    
```

1.2.2 Definition of the main architecture

Figure 1.14: Architecture / Define Architecture

Figure 1.15: Edit / Reference Operator

Figure 1.16: Architecture with one operator

To create an ArchiOneOperator architecture definition:

from the principal window: Architecture / Define Architecture (cf. figure 1.14) → dialog window: type ArchiOneOperator then click OK → definition window;
from the ArchiOneOperator definition window:
- to create a reference to the operator Uinout, Edit / Reference Operator (cf. figure 1.15) → dialog window: click user, double click Uinout → dialog window: u1,
- to define the operator as main, right click on its reference and select Set As Main Operator.

The architecture looks like the figure 1.16.

1.3 An architecture with a SAM point-to-point comunication medium

1.3.1 Definition of operators

To create Uin and Uout definitions:

from the principal window: Architecture / Define Operator → dialog window: Uin, click OK → definition window;

from the Uin definition window:

click Modify gates → dialog window:

      
        MediumSamPointToPoint x
        MediumSamMultiPoint y
        MediumRam z

click Modify durations → dialog window:

      
        computation = 2
        input = 2
        output = 5

from the principal window: Architecture / Define Operator → dialog window: Uout, click OK → definition window;

from the Uout definition window:

click Modify gates → dialog window:

      
        MediumSamPointToPoint x
        MediumSamMultiPoint y
        MediumRam z

click Modify durations → dialog window:

      
        computation = 2
        input = 5
        output = 3

1.3.2 Definition of a medium

Figure 1.17: Type of a communication medium

To create a MediumSamPointToPoint medium definition:

from the principal window: Architecture / Define Medium → dialog window: MediumSamPointToPoint, click OK → definition window;
from the MediumSamPointToPoint definition window:
- click Modify type → dialog window: SAM Point to Point (cf. figure 1.17),
- click Modify durations → dialog window:
```
      
        float = 2
        int = 2
        uchar = 1
        ushort = 1
      
    
```

1.3.3 Definition of the main architecture

To create an ArchiSamPointToPoint architecture definition:

from the principal window: Architecture / Define Architecture (cf. figure 1.14) → dialog window
ArchiSamPointToPoint → definition window;
from the ArchiSamPointToPoint definition window, create references u1 and u2 to the operators Uin and Uout;
from the ArchiSamPointToPoint definition window: Edit / Reference Medium → dialog window: click user, select MediumSamPointToPoint → dialog window: type medium_sampp;
define the operator u1 as main.

1.3.4 Connections between the operators and the medium

Figure 1.18: Architecture with two operators and a SAM point-to-point communication medium

In the main architecture window, to create a connection between the u1 operator and the medium_sampp medium, point the cursor on the port x of the operator, middle click, and drag it to the communication medium. It draws an edge between the operator and the communication medium. After creating the other connection, the main architecture looks like the figure 1.18.

1.4 An architecture with a SAM multipoint medium

To create an ArchiSamMultiPoint architecture definition:

from the principal window: Architecture / Define Architecture (cf. figure 1.14) → dialog window: ArchiSamMultiPoint → ArchiSamMultiPoint definition window;
create references u1 and u2 to the operator Uin and a reference u3 to the operator Uout, like in the previous example;

create a medium definition MediumSamMultiPoint of type SAM MultiPoint with durations:

    
      float=2
      int=2
      uchar=1
      ushort=1

create a reference medium_sammp to this medium in the main architecture window → dialog window: check No Broadcast;
define the operator u1 as main;
connect the operators ports y to the medium.

The architecture looks like the figure 1.19

Figure 1.19: Architecture with three operators and a SAM multipoint communication medium

1.5 An architecture with a RAM medium

To create the ArchiRam architecture definition:

from the principal window: Architecture / Define Architecture (cf. figure 1.14) → dialog window ArchiRam → ArchiRam definition window;
create a reference u1 to the operator Uin and references u2 and u3 to the operator Uout;
create a medium definition MediumRam of type RAM with durations
```
    
      float=2
      int=2
      uchar=1
      ushort=1
    
  
```
and create a reference medium_ram in the main architecture;
define the operator u1 as main;
connect the operators ports z to the medium.

Figure 1.20: Architecture with three operators and a RAM comunication medium

The architecture looks like the figure 1.20.

1.6 The adequation

1.6.1 Without constraint

Define the architecture with three operators and a medium of type SAM MultiPoint (cf. 1.4) as main architecture (Edit / Set As Main Architecture).

From the principal window, choose Adequation / Launch Adequation, then choose Adequation / Display schedule.

It opens the schedule window (cf. figure 1.21) in which you can see the schedule of the algorithm on the architecture and the schedule of the different inter-operator communications on the medium.

Figure 1.21: Schedule

1.6.2 With constraints

To contraint the ArchiSamMultiPoint architecture:

from the principal window, to create the constraints:
- Algorithm / Define Operation Group (cf. figure 1.22) → dialog window: og1 og2 og3,
- Constraints / Absolute Constraints → dialog window: select ArchiSamMultiPoint It opens a dialog window in which you can create constraints on the different operators of the architecture selected:
  - first click on og1, then u1, and the Create button, to constrain the operation group og1 on the operator u1,
  - constrain the operation group og2 on the operator u2,
  - constrain the operation group og3 on the operator u3,
  - click on OK button (cf. figure 1.23),
Figure 1.22: Define Operation Group

Figure 1.23: Constrain operation groups on operators of the architecture selected

Figure 1.24: Attach a reference to an operation group
in the main mode (Main button):
- select the operation in1, click on the Group button of its Reference Properties then select og1 (cf. figure 1.24),
- attach the operation in2 to the operation group og2,
- attach the operation out1 to the operation group og1,
- attach the operation out2 to the operation group og2,
- attach the operation out3 to the operation group og3,
- attach the operation calc to the operation group og3;
The algorithm with constraints looks like the figure 1.25.

Figure 1.25: Algorithm with constraints
from the principal window, to perform the adequation with constraints: Adequation / Launch Adequation, then Adequation / Display Schedule → schedule window. The schedule looks like the figure 1.26.

Figure 1.26: Schedule with constraints

From the principal window, choose File / Close. In the dialog window, click on the Save button.