message.h

/*
 * message - The message layer public common code
 *
 * Copyright (c) 2018, Archos S.A.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * * Neither the name of Archos nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
 * AND EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ARCHOS S.A. BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _MESSAGE_H_
#define _MESSAGE_H_

#include "message_common.h"

enum ack_request {
    WITHOUT_ACK,
    WITH_ACK
};

typedef enum {
    MSG_STATUS_FORMAT_ERROR = -4,
    MSG_STATUS_MIC_ERROR = -3,
    MSG_STATUS_LENGTH_ERROR = -2,
    MSG_STATUS_HEADER_ERROR = -1,
    MSG_STATUS_NO_ERROR = 0,
} message_status_t;

void message_init_format(message_format_t frame_format);

void message_init_session_keys(uint8_t *nwkskey, uint8_t *appskey);

void message_init_ids(uint32_t netid, uint32_t devaddr, uint8_t *nwkskey, uint8_t *appskey);


message_status_t message_compose(uint8_t type, uint8_t port, const uint8_t *payload, uint8_t payload_len, uint8_t *fopts, uint8_t fopts_len,
                 uint16_t seqno, message_t *msg);


message_status_t message_compose_join_OTA(uint8_t type, uint8_t *dev_eui, uint8_t *app_eui, uint16_t *dev_nonce, uint8_t *app_key, message_t *msg);


message_status_t message_decode(uint8_t *buf, uint8_t buf_len, message_t *msg);

message_status_t message_decode_join_OTA(uint8_t *buf, uint8_t buf_len, uint8_t *app_key, uint8_t *appskey, uint8_t *nwkskey, uint16_t *dev_nonce,
                     uint32_t *netid, uint32_t *devaddr, uint8_t *rx1_dr_offset, uint8_t *rx2_dr, uint8_t *rx_delay,
                     uint8_t *cf_list);

message_status_t message_authentication(message_t *msg);

enum ack_request message_ack_request(message_t *msg);

uint8_t message_get_direction(uint8_t type);

uint16_t message_max_payload_length();

message_status_t message_get_address(uint8_t *buf, uint8_t buf_len, message_t *msg);

message_status_t message_get_header(uint8_t *buf, uint8_t buf_len, message_t *msg);

#endif /* _MESSAGE_H_ */