nuttx-apps/include/industry/foc/fixed16/foc_angle.h

143 lines
4.5 KiB
C

/****************************************************************************
* apps/include/industry/foc/fixed16/foc_angle.h
*
* 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.
*
****************************************************************************/
#ifndef __INDUSTRY_FOC_FIXED16_FOC_ANGLE_H
#define __INDUSTRY_FOC_FIXED16_FOC_ANGLE_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <dspb16.h>
#include "industry/foc/fixed16/foc_handler.h"
#include "industry/foc/foc_common.h"
/****************************************************************************
* Public Type Definition
****************************************************************************/
/* Input to angle handler */
struct foc_angle_in_b16_s
{
FAR struct foc_state_b16_s *state; /* FOC state */
b16_t angle; /* Last angle */
b16_t vel; /* Last velocity */
b16_t dir; /* Movement direction */
};
/* Output from angle handler */
struct foc_angle_out_b16_s
{
uint8_t type; /* Angle type */
b16_t angle; /* Agnle */
};
/* Forward declaration */
typedef struct foc_angle_b16_s foc_angle_b16_t;
/* Angle operations */
struct foc_angle_ops_b16_s
{
/* Initialize */
CODE int (*init)(FAR foc_angle_b16_t *h);
/* Deinitialize */
CODE void (*deinit)(FAR foc_angle_b16_t *h);
/* Configure */
CODE int (*cfg)(FAR foc_angle_b16_t *h, FAR void *cfg);
/* Run */
CODE void (*run)(FAR foc_angle_b16_t *h,
FAR struct foc_angle_in_b16_s *in,
FAR struct foc_angle_out_b16_s *out);
};
/* Angle handler - sensor or sensorless */
struct foc_angle_b16_s
{
FAR struct foc_angle_ops_b16_s *ops;
FAR void *data;
};
#ifdef CONFIG_INDUSTRY_FOC_ANGLE_OPENLOOP
/* Open-loop configuration data */
struct foc_openloop_cfg_b16_s
{
b16_t per; /* Controller period */
};
#endif
/****************************************************************************
* Public Data
****************************************************************************/
#ifdef CONFIG_INDUSTRY_FOC_ANGLE_OPENLOOP
/* Open-loop angle operations (fixed16) */
extern struct foc_angle_ops_b16_s g_foc_angle_ol_b16;
#endif
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: foc_angle_init_b16
****************************************************************************/
int foc_angle_init_b16(FAR foc_angle_b16_t *h,
FAR struct foc_angle_ops_b16_s *ops);
/****************************************************************************
* Name: foc_angle_deinit_b16
****************************************************************************/
int foc_angle_deinit_b16(FAR foc_angle_b16_t *h);
/****************************************************************************
* Name: foc_angle_cfg_b16
****************************************************************************/
int foc_angle_cfg_b16(FAR foc_angle_b16_t *h, FAR void *cfg);
/****************************************************************************
* Name: foc_angle_run_b16
****************************************************************************/
void foc_angle_run_b16(FAR foc_angle_b16_t *h,
FAR struct foc_angle_in_b16_s *in,
FAR struct foc_angle_out_b16_s *out);
#endif /* __INDUSTRY_FOC_FIXED16_FOC_ANGLE_H */