Studio:Scl conform

The scl_conform pragma

The scl_conform pragma allows the user to define a conformant array within a payload. The payload can be a C structure or a parameter declaration list. The conformant array must be the last item in the payload (e.g., the last field in the structure, or the last parameter in the declaration list). Because of this, only the payload name and the name of the size field in that payload are required. The SCL compiler automatically assumes the conformant array field within the specified payload.

NOTE: For an alternative use case of sized structure please look at scl_struct_sized pragma.

Syntax

#pragma scl_conform(name, size-name, max-size)

Parameters	Type	Description
name	String	Name of the structure or function that encapsulates the conformant array The following restrictions apply: The structure type may not be pointed to by a sized pointer. The structure type may not be used in an array. The structure type may not be a member of an union. The structure type may not be a member of any other structure unless it is the last member. The structure type may not be passed as a function parameter (but a pointer to it is allowed). The structure type may reside only within IN or INOUT memory blocks.
size-name	Member	Name of the structure field or function parameter that contains the size of the array The following restrictions apply: The type of the size-name must be an integral type. The size-field must reside within the same payload block as the structure or the function payload.
max-size	Integer	Maximum size of the conformant array

Example

/* Constant defining the maximum array size */
#define MAX_BUFFER_SIZE 20

/* Structure defining a message payload with a conformant array */
/* The array field must be the last member in the payload       */
typedef struct {
  int f1;
  short bufferSize;
  char  buffer[1];
} CmdPayload_t;

/* Use the scl_conform pragma to define the conformant arrays */
#pragma scl_conform( CmdPayload_t, bufferSize, MAX_BUFFER_SIZE )

See Also

• For additional information on scl_conform, including constraints, refer to the section on scl_conform in the SCL Reference Guide.