* For now, only UI frames without any Layer 3 protocol are handled.
* This however is enough to send/receive APRS packets.
*
- * \version $Id$
* \author Francesco Sacchi <batt@develer.com>
*
* $WIZ$ module_name = "ax25"
#include "cfg/cfg_ax25.h"
#include <cfg/compiler.h>
-#include <kern/kfile.h>
+#include <io/kfile.h>
/**
* Maximum size of a AX25 frame.
uint8_t ssid; ///< SSID (secondary station ID) for the call
} AX25Call;
+/**
+ * Create an AX25Call structure on the fly.
+ * \param str callsign, can be 6 characters or shorter.
+ * \param id ssid associated with the callsign.
+ */
+#define AX25_CALL(str, id) {.call = (str), .ssid = (id) }
+
/**
* Maximum number of Repeaters in a AX25 message.
*/
#define AX25_MAX_RPT 8
+/*
+ * Has to be lesser than 8 in order to fit in one byte
+ * change AX25Msg.rpt_flags if you need more repeaters.
+ */
+STATIC_ASSERT(AX25_MAX_RPT <= 8);
/**
* AX25 Message.
#if CONFIG_AX25_RPT_LST
AX25Call rpt_lst[AX25_MAX_RPT]; ///< List of repeaters
uint8_t rpt_cnt; ///< Number of repeaters in this message
+ uint8_t rpt_flags; ///< Has-been-repeated flags for each repeater (bit-mapped)
+ #define AX25_REPEATED(msg, idx) ((msg)->rpt_flags & BV(idx))
#endif
uint16_t ctrl; ///< AX25 control field
uint8_t pid; ///< AX25 PID field
size_t len; ///< Payload length
} AX25Msg;
+
#define AX25_CTRL_UI 0x03
#define AX25_PID_NOLAYER3 0xF0
/**
- * Check if there are any AX25 messages to be processed.
- * This function read available characters from the medium and search for
- * any AX25 messages.
- * If a message is found it is decoded and the linked callback executed.
- * This function may be blocking if there are no available chars and the KFile
- * used in \a ctx to access the medium is configured in blocking mode.
+ * Declare an AX25 path.
+ * \param dst the destination callsign for the path, \see AX25_CALL
+ * for a handy way to create a callsign on the fly.
+ * \param src the source callsign for the path, \see AX25_CALL
+ * for a handy way to create a callsign on the fly.
*
- * \param ctx AX25 context to operate on.
+ * Additional optional callsigns can be specified at the end of this macro
+ * in order to add repeater callsigns or specific unproto paths.
+ *
+ * This macro can be used to simply path array declaration.
+ * Should be used in this way:
+ * \code
+ * AX25Call path[] = AX25_PATH(AX25_CALL("abcdef", 0), AX25_CALL("ghjklm", 0), AX25_CALL("wide1", 1), AX25_CALL("wide2", 2));
+ * \endcode
+ *
+ * The declared path can then be passed to ax25_sendVia().
*/
+#define AX25_PATH(dst, src, ...) { dst, src, ## __VA_ARGS__ }
+
void ax25_poll(AX25Ctx *ctx);
+void ax25_sendVia(AX25Ctx *ctx, const AX25Call *path, size_t path_len, const void *_buf, size_t len);
/**
- * Init the AX25 protocol decoder.
+ * Send an AX25 frame on the channel.
+ * \param ctx AX25 context to operate on.
+ * \param dst the destination callsign for the frame, \see AX25_CALL
+ * for a handy way to create a callsign on the fly.
+ * \param src the source callsign for the frame, \see AX25_CALL
+ * for a handy way to create a callsign on the fly.
+ * \param buf payload buffer.
+ * \param len length of the payload.
*
- * \param ctx AX25 context to init.
- * \param channel Used to gain access to the physical medium
- * \param hook Callback function called when a message is received
+ * \see ax25_sendVia() if you want to send a frame with a specific path.
*/
+#define ax25_send(ctx, dst, src, buf, len) ax25_sendVia(ctx, ({static AX25Call __path[]={dst, src}; __path;}), 2, buf, len)
void ax25_init(AX25Ctx *ctx, KFile *channel, ax25_callback_t hook);
+void ax25_print(KFile *ch, const AX25Msg *msg);
+
int ax25_testSetup(void);
int ax25_testTearDown(void);
int ax25_testRun(void);