nuttx-apps/industry/foc/fixed16/foc_ang_openloop.c

/****************************************************************************
 * apps/industry/foc/fixed16/foc_ang_openloop.c
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#include <assert.h>
#include <errno.h>
#include <stdlib.h>
#include <string.h>

#include "industry/foc/foc_log.h"
#include "industry/foc/fixed16/foc_angle.h"

/****************************************************************************
 * Private Data Types
 ****************************************************************************/

/* Open-loop data */

struct foc_openloop_b16_s
{
  struct foc_openloop_cfg_b16_s cfg;
  struct openloop_data_b16_s    data;
  b16_t                         dir;
};

/****************************************************************************
 * Private Function Prototypes
 ****************************************************************************/

static int foc_angle_ol_init_b16(FAR foc_angle_b16_t *h);
static void foc_angle_ol_deinit_b16(FAR foc_angle_b16_t *h);
static int foc_angle_ol_cfg_b16(FAR foc_angle_b16_t *h, FAR void *cfg);
static int foc_angle_ol_zero_b16(FAR foc_angle_b16_t *h);
static int foc_angle_ol_dir_b16(FAR foc_angle_b16_t *h, b16_t dir);
static int foc_angle_ol_run_b16(FAR foc_angle_b16_t *h,
                                FAR struct foc_angle_in_b16_s *in,
                                FAR struct foc_angle_out_b16_s *out);

/****************************************************************************
 * Public Data
 ****************************************************************************/

struct foc_angle_ops_b16_s g_foc_angle_ol_b16 =
{
  .init   = foc_angle_ol_init_b16,
  .deinit = foc_angle_ol_deinit_b16,
  .cfg    = foc_angle_ol_cfg_b16,
  .zero   = foc_angle_ol_zero_b16,
  .dir    = foc_angle_ol_dir_b16,
  .run    = foc_angle_ol_run_b16,
};

/****************************************************************************
 * Private Functions
 ****************************************************************************/

/****************************************************************************
 * Name: foc_angle_ol_init_b16
 *
 * Description:
 *   Initialize the open-loop FOC angle handler (fixed16)
 *
 * Input Parameter:
 *   h - pointer to FOC angle handler
 *
 ****************************************************************************/

static int foc_angle_ol_init_b16(FAR foc_angle_b16_t *h)
{
  int ret = OK;

  DEBUGASSERT(h);

  /* Connect angle data */

  h->data = zalloc(sizeof(struct foc_openloop_b16_s));
  if (h->data == NULL)
    {
      ret = -ENOMEM;
      goto errout;
    }

errout:
  return ret;
}

/****************************************************************************
 * Name: foc_angle_ol_deinit_b16
 *
 * Description:
 *   De-initialize the open-loop FOC angle handler (fixed16)
 *
 * Input Parameter:
 *   h - pointer to FOC angle handler
 *
 ****************************************************************************/

static void foc_angle_ol_deinit_b16(FAR foc_angle_b16_t *h)
{
  DEBUGASSERT(h);

  /* Free angle data */

  if (h->data)
    {
      free(h->data);
    }
}

/****************************************************************************
 * Name: foc_angle_ol_cfg_b16
 *
 * Description:
 *   Configure the open-loop FOC angle handler (fixed16)
 *
 * Input Parameter:
 *   h   - pointer to FOC angle handler
 *   cfg - pointer to angle handler configuration data
 *         (struct foc_openloop_b16_s)
 *
 ****************************************************************************/

static int foc_angle_ol_cfg_b16(FAR foc_angle_b16_t *h, FAR void *cfg)
{
  FAR struct foc_openloop_b16_s *ol = NULL;

  DEBUGASSERT(h);

  /* Get open-loop data */

  DEBUGASSERT(h->data);
  ol = h->data;

  /* Copy configuration */

  memcpy(&ol->cfg, cfg, sizeof(struct foc_openloop_cfg_b16_s));

  /* Initialize open-loop controller data */

  DEBUGASSERT(ol->cfg.per > 0);
  motor_openloop_init_b16(&ol->data, ol->cfg.per);

  /* Initialize with CW direction */

  ol->dir = DIR_CW_B16;

  return OK;
}

/****************************************************************************
 * Name: foc_angle_ol_zero_b16
 *
 * Description:
 *   Zero the open-loop FOC angle handler (fixed16)
 *
 * Input Parameter:
 *   h   - pointer to FOC angle handler
 *   dir - sensor direction (1 if normal -1 if inverted)
 *
 ****************************************************************************/

static int foc_angle_ol_zero_b16(FAR foc_angle_b16_t *h)
{
  FAR struct foc_openloop_b16_s *ol = NULL;

  DEBUGASSERT(h);

  /* Get open-loop data */

  DEBUGASSERT(h->data);
  ol = h->data;

  /* Reset angle */

  ol->data.angle = 0;

  return OK;
}

/****************************************************************************
 * Name: foc_angle_ol_dir_b16
 *
 * Description:
 *   Set the open-loop FOC angle handler direction (fixed16)
 *
 * Input Parameter:
 *   h   - pointer to FOC angle handler
 *   dir - sensor direction (1 if normal -1 if inverted)
 *
 ****************************************************************************/

static int foc_angle_ol_dir_b16(FAR foc_angle_b16_t *h, b16_t dir)
{
  FAR struct foc_openloop_b16_s *ol = NULL;

  DEBUGASSERT(h);

  UNUSED(dir);

  /* Get open-loop data */

  DEBUGASSERT(h->data);
  ol = h->data;

  /* Configure direction */

  ol->dir = dir;

  return OK;
}

/****************************************************************************
 * Name: foc_angle_ol_run_b16
 *
 * Description:
 *   Process the FOC open-loop angle data (fixed16)
 *
 * Input Parameter:
 *   h   - pointer to FOC angle handler
 *   in  - pointer to FOC angle handler input data
 *   out - pointer to FOC angle handler output data
 *
 ****************************************************************************/

static int foc_angle_ol_run_b16(FAR foc_angle_b16_t *h,
                                FAR struct foc_angle_in_b16_s *in,
                                FAR struct foc_angle_out_b16_s *out)
{
  FAR struct foc_openloop_b16_s *ol = NULL;
  b16_t tmp = 0;

  DEBUGASSERT(h);

  /* Get open-loop data */

  DEBUGASSERT(h->data);
  ol = h->data;

  /* Update open-loop.
   * NOTE: we don't use dir argument here, instead we use signed velocity.
   */

  motor_openloop_b16(&ol->data, in->vel, 1);

  tmp = motor_openloop_angle_get_b16(&ol->data);

  /* Get open-loop angle */

  out->type  = FOC_ANGLE_TYPE_ELE;
  out->angle = b16mulb16(ol->dir, tmp);

  return OK;
}