constant.c

Go to the documentation of this file.

/*
 * Copyright (c) 2012, Silvio Vallorani <silvio.vallorani@studio.unibo.it>
 *
 * Permission  to  use,  copy,  modify,  and/or distribute this
 * software  for  any  purpose  with  or  without fee is hereby
 * granted,  provided  that the above copyright notice and this
 * permission notice appear in all copies.
 *
 * THE  SOFTWARE  IS  PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS
 * ALL  WARRANTIES  WITH  REGARD TO THIS SOFTWARE INCLUDING ALL
 * IMPLIED  WARRANTIES  OF  MERCHANTABILITY  AND FITNESS. IN NO
 * EVENT  SHALL  THE  AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT,   OR   CONSEQUENTIAL   DAMAGES   OR   ANY  DAMAGES
 * WHATSOEVER  RESULTING  FROM  LOSS  OF  USE, DATA OR PROFITS,
 * WHETHER  IN  AN  ACTION  OF  CONTRACT,  NEGLIGENCE  OR OTHER
 * TORTIOUS  ACTION,  ARISING  OUT OF OR IN CONNECTION WITH THE
 * USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 */
#include "hapticLib.h"

uint8_t constantContinuator(pattern_desc *pattern)
{

        /*
         * Create a handy reference for userParameters and statusParameters
         * Note:
         *              - userParams data reside on the user program module. (main.c)
         *              - statusParams data reside on SystemDesc variable.
         */
        constantUserParameters     *userParams = &pattern->userParams->constant;
        constantStatusParameters *statusParams = &pattern->statusParams.constant;

        statusParams->duty = userParams->constant;

        TIM_Channel_DutyChanger( dutyConverter(statusParams->duty, pattern->activeHaptorList), \
                                                                pattern->activeHaptorList->id );

        return 0;

}

uint8_t constantPatternGenerator(pattern_desc *pattern)
{
        /*
         * Create a handy reference for userParameters
         *                        and statusParameters
         * Note:
         *              - userParams data reside on the user
         *                                      program module. (main.c)
         *              - statusParams data reside on SystemDesc
         *                                      variable.
         */
        constantUserParameters     *userParams = &pattern->userParams->constant;
        constantStatusParameters *statusParams = &pattern->statusParams.constant;


        // User Parameters Validation:
        // Input validation must be made before attempting
        // to use the provided parameters.
        if( userParams == NULL )
        {
#ifdef HL_DEBUG
                send_string("constantPatternGenerator(): expecting optional Parameters, NULL found.\r\n\0");
#endif
                return 1;
        }

        // Status initialization based on user provided parameters...
        statusParams->duty = userParams->constant;


        // Last duty: Set the continuator up for scheduling.
        pattern->continuator  = &constantContinuator;

        return 0;
}