serial_msp.h

Go to the documentation of this file.

/*
 * This file is part of Ninjaflight.
 *
 * Ninjaflight is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Ninjaflight is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Ninjaflight.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once


// Each MSP port requires state and a receive buffer, revisit this default if someone needs more than 2 MSP ports.
#define MAX_MSP_PORT_COUNT 2

#include "drivers/serial.h"

typedef enum {
    IDLE,
    HEADER_M,
    HEADER_ARROW,
    HEADER_SIZE,
    HEADER_CMD,
    HEADER_DATA,
    COMMAND_RECEIVED
} mspState_e;

#define MSP_PORT_INBUF_SIZE 64
#define MSP_PORT_OUTBUF_SIZE 256

struct serial_msp_port {
    serialPort_t *port;                      // NULL when port unused.
    mspState_e c_state;
    uint8_t offset;
    uint8_t dataSize;
    uint8_t cmdMSP;
    uint8_t inBuf[MSP_PORT_INBUF_SIZE];
};

struct ninja;
struct msp;

struct serial_msp {
    struct serial_msp_port ports[MAX_MSP_PORT_COUNT];
    const struct config *config;
    struct msp *msp;
};

// TODO: look into the dependency here. serial_msp is pointing to msp parser which processes commands received from multiple msp ports managed by single serial_msp object.

void serial_msp_init(struct serial_msp *self, const struct config *config, struct msp *msp);
void serial_msp_process(struct serial_msp *self, struct ninja *ninja);
//void serial_msp_alloc_ports(struct serial_msp *self);
void serial_msp_release_port(struct serial_msp *self, serialPort_t *serialPort);