Studio:SCL Samples - Revision history

Ivailop: moved SCL Samples to Studio:SCL Samples

2010-05-07T04:58:53Z

← Older revision	Revision as of 04:58, 7 May 2010
(No difference)

Ivailop: /* Prerequisites */

2010-05-07T04:58:33Z

Prerequisites

← Older revision		Revision as of 04:58, 7 May 2010
Line 4:		Line 4:

	==Prerequisites==		==Prerequisites==
	Before starting, some prerequisites must be satisfied. For details and instructions, see [[Desktop Installation]].		Before starting, some prerequisites must be satisfied. For details and instructions, see [[Studio:Desktop Installation]].

	Specifically:		Specifically:

Timd at 00:04, 2 September 2009

2009-09-02T00:04:24Z

← Older revision		Revision as of 00:04, 2 September 2009
Line 163:		Line 163:


	[[Category: Samples]]		[[Category:Studio:Samples]]

Stevel at 00:35, 10 December 2008

2008-12-10T00:35:10Z

← Older revision		Revision as of 00:35, 10 December 2008
Line 4:		Line 4:

	==Prerequisites==		==Prerequisites==
	Before starting, some prerequisites must be satisfied. For details and instructions, see [[~~Host_Installation\|Host~~ Installation]].		Before starting, some prerequisites must be satisfied. For details and instructions, see [[Desktop Installation]].

	Specifically:		Specifically:

Stevel: /* VariantMessage.h */

2008-10-15T20:07:22Z

VariantMessage.h

← Older revision		Revision as of 20:07, 15 October 2008
Line 85:		Line 85:

	The '''<tt>f_send_variant_msg</tt>''' interface is captured and its parameters are qualified:		The '''<tt>f_send_variant_msg</tt>''' interface is captured and its parameters are qualified:
	*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>~~VarMsg_t~~</tt>''' structure type to the '''<tt>~~VarMsg_Cast_t~~</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>~~VarMsg_Union_t~~</tt>''' union member. This is a union of structures that is discriminated by the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>f_get_dial_params_size</tt>''', '''<tt>f_get_register_params_size</tt>''', '''<tt>f_get_sendmsg_params_size</tt>''', and '''<tt>f_get_sendmsgack_params_size</tt>''' utilities.		*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>varmsg_t</tt>''' structure type to the '''<tt>varmsg_cast_t</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>varmsg_union_t</tt>''' union member. This is a union of structures that is discriminated by the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>f_get_dial_params_size</tt>''', '''<tt>f_get_register_params_size</tt>''', '''<tt>f_get_sendmsg_params_size</tt>''', and '''<tt>f_get_sendmsgack_params_size</tt>''' utilities.
	*The <tt>msg_id</tt> member is constrained to a subset of the message code enumerations defined in the '''<tt>e_discriminant_codes</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.		*The <tt>msg_id</tt> member is constrained to a subset of the message code enumerations defined in the '''<tt>e_discriminant_codes</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.
	*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.		*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.

Stevel: /* VariantMessage.h */

2008-10-15T20:03:58Z

VariantMessage.h

← Older revision		Revision as of 20:03, 15 October 2008
Line 84:		Line 84:
	Like the pattern in Ioctl.h, the Variant Message pattern is a message call where the parameter represents varying information, controlled by a discriminant field. However, in this case the payload varies in size based on the discriminant value.		Like the pattern in Ioctl.h, the Variant Message pattern is a message call where the parameter represents varying information, controlled by a discriminant field. However, in this case the payload varies in size based on the discriminant value.

	The '''<tt>~~f_SendVariantMsg~~</tt>''' interface is captured and its parameters are qualified:		The '''<tt>f_send_variant_msg</tt>''' interface is captured and its parameters are qualified:
	*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>VarMsg_t</tt>''' structure type to the '''<tt>VarMsg_Cast_t</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>VarMsg_Union_t</tt>''' union member. This is a union of structures that is discriminated by the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>~~f_GetRegisterParamsSize~~</tt>''', '''<tt>~~f_GetDialParamsSize~~</tt>''', '''<tt>~~f_GetSendmsgParamsSize~~</tt>''', and '''<tt>~~f_GetSendmsgAckParamsSize~~</tt>''' utilities.		*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>VarMsg_t</tt>''' structure type to the '''<tt>VarMsg_Cast_t</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>VarMsg_Union_t</tt>''' union member. This is a union of structures that is discriminated by the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>f_get_dial_params_size</tt>''', '''<tt>f_get_register_params_size</tt>''', '''<tt>f_get_sendmsg_params_size</tt>''', and '''<tt>f_get_sendmsgack_params_size</tt>''' utilities.
	*The <tt>msg_id</tt> member is constrained ~~the~~ the message code enumerations defined in the '''<tt>~~e_Discriminant_Codes~~</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.		*The <tt>msg_id</tt> member is constrained to a subset of the message code enumerations defined in the '''<tt>e_discriminant_codes</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.
	*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.		*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.
	*The members of the union are mapped to activate values that have been constrained to the <tt>msg_id</tt> member earlier. This is done with the <tt>[[scl_union_activate]]</tt> pragmas.<br>		*The members of the union are mapped to activate values that have been constrained to the <tt>msg_id</tt> member earlier. This is done with the <tt>[[scl_union_activate]]</tt> pragmas.<br>

Stevel: /* Ioctl.h */

2008-10-15T19:56:50Z

Ioctl.h

← Older revision		Revision as of 19:56, 15 October 2008
Line 69:		Line 69:
	The SCL pattern presented in the Ioctl.h header file represents an I/O Control system call. The single interface provides access for several different messages exchanged with the target. The '''<tt>dwCode</tt>''' parameter switches the structure of the input and output buffers that accompany the call. The pBufIn and pBufOut parameters are cast to unions of pointers to send/receive variable data blocks, yet the size of the payload remains constant.		The SCL pattern presented in the Ioctl.h header file represents an I/O Control system call. The single interface provides access for several different messages exchanged with the target. The '''<tt>dwCode</tt>''' parameter switches the structure of the input and output buffers that accompany the call. The pBufIn and pBufOut parameters are cast to unions of pointers to send/receive variable data blocks, yet the size of the payload remains constant.

	The '''<tt>~~f_IOControl~~</tt>''' interface is captured and its parameters qualified:		The '''<tt>f_io_control</tt>''' interface is captured and its parameters qualified:
	*Using the <tt>[[scl_values]]</tt> pragma, the '''dwCode''' parameter is constrained to allow only the values of the '''<tt>~~e_Discriminant_Codes~~</tt>''' enumerated type, as these values determine the structure of the remaining parameters.		*Using the <tt>[[scl_values]]</tt> pragma, the '''dwCode''' parameter is constrained to allow only the values of the '''<tt>e_discriminant_codes</tt>''' enumerated type, as these values determine the structure of the remaining parameters.
	*The '''<tt>pBufIn</tt>''' pointer parameter is cast with <tt>[[scl_cast]]</tt> to a union of pointers, the '''<tt>~~IOCtl_BufIn_t~~</tt>''' type.		*The '''<tt>pBufIn</tt>''' pointer parameter is cast with <tt>[[scl_cast]]</tt> to a union of pointers, the '''<tt>ioctl_buf_in_t</tt>''' type.
	*The casted input union ('''<tt>pBufIn</tt>''') is then qualified with the <tt>[[scl_union]]</tt> pragma. The input union discriminant is set to the '''<tt>dwCode</tt>''' parameter, whose value controls the active member of the input union. These members are pointers to various structures that contain send data, e.g. register ids, phone numbers, etc.		*The casted input union ('''<tt>pBufIn</tt>''') is then qualified with the <tt>[[scl_union]]</tt> pragma. The input union discriminant is set to the '''<tt>dwCode</tt>''' parameter, whose value controls the active member of the input union. These members are pointers to various structures that contain send data, e.g. register ids, phone numbers, etc.
	*The input union's members are then mapped to activate values in the '''<tt>~~e_Discriminant_Codes~~</tt>''' enumerated type - the ones that regulate input messages.<br>		*The input union's members are then mapped to activate values in the '''<tt>e_discriminant_codes</tt>''' enumerated type - the ones that regulate input messages.<br>
	*The '''<tt>pBufOut</tt>''' pointer parameter is cast with <tt>[[scl_cast]]</tt> to a union of pointers, the '''<tt>~~IOCtl_BufOut_t~~</tt>''' type. This union type has pointer members that have been qualified as '''OUT''' direction.		*The '''<tt>pBufOut</tt>''' pointer parameter is cast with <tt>[[scl_cast]]</tt> to a union of pointers, the '''<tt>ioctl_buf_out_t</tt>''' type. This union type has pointer members that have been qualified as '''OUT''' direction.
	*The casted output union ('''<tt>pBufOut</tt>''') is then qualified with the <tt>[[scl_union]]</tt> pragma.		*The casted output union ('''<tt>pBufOut</tt>''') is then qualified with the <tt>[[scl_union]]</tt> pragma.
	*The output union discriminant is set to the '''<tt>dwCode</tt>''' parameter.		*The output union discriminant is set to the '''<tt>dwCode</tt>''' parameter.
	*The members of the output union are mapped to activate values in the '''<tt>~~e_Discriminant_Codes~~</tt>''' enumerated type - the ones that regulate output results. This is done with the <tt>[[scl_union_activate]]</tt> pragmas.<br>		*The members of the output union are mapped to activate values in the '''<tt>e_discriminant_codes</tt>''' enumerated type - the ones that regulate output results. This is done with the <tt>[[scl_union_activate]]</tt> pragmas.<br>
	*The '''<tt>pdwActualOut</tt>''' parameter is qualified to the '''OUT''' direction, to receive read messages as a result of a '''READMSG''' system call.		*The '''<tt>pdwActualOut</tt>''' parameter is qualified to the '''OUT''' direction, to receive read messages as a result of a '''READMSG''' system call.


	====<i>VariantMessage.h</i>====		====<i>VariantMessage.h</i>====

Stevel: /* VariantMessage.h */

2008-10-15T19:03:08Z

VariantMessage.h

← Older revision		Revision as of 19:03, 15 October 2008
Line 85:		Line 85:
	Like the pattern in Ioctl.h, the Variant Message pattern is a message call where the parameter represents varying information, controlled by a discriminant field. However, in this case the payload varies in size based on the discriminant value.		Like the pattern in Ioctl.h, the Variant Message pattern is a message call where the parameter represents varying information, controlled by a discriminant field. However, in this case the payload varies in size based on the discriminant value.

	The '''<tt>~~f_Variant_Msg~~</tt>''' interface is captured and its parameters are qualified:		The '''<tt>f_SendVariantMsg</tt>''' interface is captured and its parameters are qualified:
	*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>VarMsg_t</tt>''' structure type to the '''<tt>VarMsg_Cast_t</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>VarMsg_Union_t</tt>''' union member. This is a union of structures that is discriminated by the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>~~f_get_register_params_size~~</tt>''', '''<tt>~~f_get_dial_params_size~~</tt>''', '''<tt>~~f_get_sendmsg_params_size~~</tt>''', and '''<tt>~~f_get_sendmsgack_params_size~~</tt>''' utilities.		*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>VarMsg_t</tt>''' structure type to the '''<tt>VarMsg_Cast_t</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>VarMsg_Union_t</tt>''' union member. This is a union of structures that is discriminated by the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>f_GetRegisterParamsSize</tt>''', '''<tt>f_GetDialParamsSize</tt>''', '''<tt>f_GetSendmsgParamsSize</tt>''', and '''<tt>f_GetSendmsgAckParamsSize</tt>''' utilities.
	*The <tt>msg_id</tt> member is constrained the the message code enumerations defined in the '''<tt>e_Discriminant_Codes</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.		*The <tt>msg_id</tt> member is constrained the the message code enumerations defined in the '''<tt>e_Discriminant_Codes</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.
	*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.		*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.

Stevel: /* VariantMessage.h */

2008-10-15T18:50:36Z

VariantMessage.h

← Older revision		Revision as of 18:50, 15 October 2008
Line 86:		Line 86:

	The '''<tt>f_Variant_Msg</tt>''' interface is captured and its parameters are qualified:		The '''<tt>f_Variant_Msg</tt>''' interface is captured and its parameters are qualified:
	*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>VarMsg_t</tt>''' structure type to the '''<tt>VarMsg_Cast_t</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>VarMsg_Union_t</tt>''' union member. This is a union of structures that ~~matches~~ the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>f_get_register_params_size</tt>''', '''<tt>f_get_dial_params_size</tt>''', '''<tt>f_get_sendmsg_params_size</tt>''', and '''<tt>f_get_sendmsgack_params_size</tt>''' utilities.		*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>VarMsg_t</tt>''' structure type to the '''<tt>VarMsg_Cast_t</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>VarMsg_Union_t</tt>''' union member. This is a union of structures that is discriminated by the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>f_get_register_params_size</tt>''', '''<tt>f_get_dial_params_size</tt>''', '''<tt>f_get_sendmsg_params_size</tt>''', and '''<tt>f_get_sendmsgack_params_size</tt>''' utilities.
	*The <tt>msg_id</tt> member is constrained the the message code enumerations defined in the '''<tt>e_Discriminant_Codes</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.		*The <tt>msg_id</tt> member is constrained the the message code enumerations defined in the '''<tt>e_Discriminant_Codes</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.
	*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.		*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.

Stevel: /* VariantMessage.h */

2008-10-15T18:49:34Z

VariantMessage.h

← Older revision		Revision as of 18:49, 15 October 2008
Line 86:		Line 86:

	The '''<tt>f_Variant_Msg</tt>''' interface is captured and its parameters are qualified:		The '''<tt>f_Variant_Msg</tt>''' interface is captured and its parameters are qualified:
	*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>VarMsg_t</tt>''' structure type to the '''<tt>VarMsg_Cast_t</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>VarMsg_Union_t</tt>''' union member. This is a union of structures that matches the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>~~get_register_params_size~~</tt>''', '''<tt>~~get_dial_params_size~~</tt>''', '''<tt>~~get_sendmsg_params_size~~</tt>''', and '''<tt>f_get_sendmsgack_params_size</tt>''' utilities.		*The '''<tt>msg</tt>''' parameter is cast from the '''<tt>VarMsg_t</tt>''' structure type to the '''<tt>VarMsg_Cast_t</tt>''' structure, which overlays the same '''<tt>msg_id</tt>''' and '''<tt>body_len</tt>''' members that the original structure had, but the last member of the original structure, the single element <tt>char</tt> array, is replaced by a '''<tt>VarMsg_Union_t</tt>''' union member. This is a union of structures that matches the set of values that will be assigned to the <tt>msg_id</tt> member. The <tt>body_len</tt> field will contain the final payload size, which can be initialized by using the '''<tt>f_get_register_params_size</tt>''', '''<tt>f_get_dial_params_size</tt>''', '''<tt>f_get_sendmsg_params_size</tt>''', and '''<tt>f_get_sendmsgack_params_size</tt>''' utilities.
	*The <tt>msg_id</tt> member is constrained the the message code enumerations defined in the '''<tt>e_Discriminant_Codes</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.		*The <tt>msg_id</tt> member is constrained the the message code enumerations defined in the '''<tt>e_Discriminant_Codes</tt>''' type in the included <i>types.h</i> file. This is done with the <tt>[[scl_values]]</tt> pragma.
	*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.		*The casted union member is then qualified with the <tt>[[scl_union]]</tt> pragma. The union discriminant is set to the <tt>msg_id</tt> member.