aboutsummaryrefslogtreecommitdiff
path: root/circuitpython/supervisor/shared/bluetooth/file_transfer_protocol.h
diff options
context:
space:
mode:
authorRaghuram Subramani <raghus2247@gmail.com>2022-06-19 19:47:51 +0530
committerRaghuram Subramani <raghus2247@gmail.com>2022-06-19 19:47:51 +0530
commit4fd287655a72b9aea14cdac715ad5b90ed082ed2 (patch)
tree65d393bc0e699dd12d05b29ba568e04cea666207 /circuitpython/supervisor/shared/bluetooth/file_transfer_protocol.h
parent0150f70ce9c39e9e6dd878766c0620c85e47bed0 (diff)
add circuitpython code
Diffstat (limited to 'circuitpython/supervisor/shared/bluetooth/file_transfer_protocol.h')
-rw-r--r--circuitpython/supervisor/shared/bluetooth/file_transfer_protocol.h180
1 files changed, 180 insertions, 0 deletions
diff --git a/circuitpython/supervisor/shared/bluetooth/file_transfer_protocol.h b/circuitpython/supervisor/shared/bluetooth/file_transfer_protocol.h
new file mode 100644
index 0000000..3bc1f61
--- /dev/null
+++ b/circuitpython/supervisor/shared/bluetooth/file_transfer_protocol.h
@@ -0,0 +1,180 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_SUPERVISOR_SHARED_BLUETOOTH_FILE_TRANSFER_PROTOCOL_H
+#define MICROPY_INCLUDED_SUPERVISOR_SHARED_BLUETOOTH_FILE_TRANSFER_PROTOCOL_H
+
+#include <stdint.h>
+
+// See https://github.com/adafruit/Adafruit_CircuitPython_BLE_File_Transfer
+// for full protocol documentation and a Python client API.
+
+// Each struct is packed so that no padding is added by the compiler. (structs
+// may having padding at the end in order to align a particular element when in
+// an array of the struct.) So, be careful that types added are aligned. Otherwise,
+// the compiler may generate more code than necessary.
+
+// 0x00 - 0x0f are never used by the protocol as a command
+#define READ 0x10
+struct read_command {
+ uint8_t command;
+ uint8_t reserved;
+ uint16_t path_length;
+ uint32_t chunk_offset;
+ uint32_t chunk_size;
+ uint8_t path[];
+} __attribute__((packed));
+
+#define READ_DATA 0x11
+struct read_data {
+ uint8_t command;
+ uint8_t status;
+ uint16_t reserved;
+ uint32_t chunk_offset;
+ uint32_t total_length;
+ uint32_t data_size;
+ uint8_t data[];
+} __attribute__((packed));
+
+#define READ_PACING 0x12
+struct read_pacing {
+ uint8_t command;
+ uint8_t status;
+ uint16_t reserved;
+ uint32_t chunk_offset;
+ uint32_t chunk_size;
+} __attribute__((packed));
+
+#define WRITE 0x20
+struct write_command {
+ uint8_t command;
+ uint8_t reserved;
+ uint16_t path_length;
+ uint32_t offset;
+ uint64_t modification_time;
+ uint32_t total_length;
+ uint8_t path[];
+} __attribute__((packed));
+
+#define WRITE_PACING 0x21
+struct write_pacing {
+ uint8_t command;
+ uint8_t status;
+ uint16_t reserved;
+ uint32_t offset;
+ uint64_t truncated_time;
+ uint32_t free_space;
+} __attribute__((packed));
+
+#define WRITE_DATA 0x22
+struct write_data {
+ uint8_t command;
+ uint8_t status;
+ uint16_t reserved;
+ uint32_t offset;
+ uint32_t data_size;
+ uint8_t data[];
+} __attribute__((packed));
+
+#define DELETE 0x30
+struct delete_command {
+ uint8_t command;
+ uint8_t reserved;
+ uint16_t path_length;
+ uint8_t path[];
+} __attribute__((packed));
+
+#define DELETE_STATUS 0x31
+struct delete_status {
+ uint8_t command;
+ uint8_t status;
+} __attribute__((packed));
+
+#define MKDIR 0x40
+struct mkdir_command {
+ uint8_t command;
+ uint8_t reserved;
+ uint16_t path_length;
+ uint32_t reserved2;
+ uint64_t modification_time;
+ uint8_t path[];
+} __attribute__((packed));
+
+#define MKDIR_STATUS 0x41
+struct mkdir_status {
+ uint8_t command;
+ uint8_t status;
+ uint16_t reserved;
+ uint32_t reserved2;
+ uint64_t truncated_time;
+} __attribute__((packed));
+
+#define LISTDIR 0x50
+struct listdir_command {
+ uint8_t command;
+ uint8_t reserved;
+ uint16_t path_length;
+ uint8_t path[];
+} __attribute__((packed));
+
+#define LISTDIR_ENTRY 0x51
+struct listdir_entry {
+ uint8_t command;
+ uint8_t status;
+ uint16_t path_length;
+ uint32_t entry_number;
+ uint32_t entry_count;
+ uint32_t flags;
+ uint64_t truncated_time;
+ uint32_t file_size;
+ uint8_t path[];
+} __attribute__((packed));
+
+#define MOVE 0x60
+struct move_command {
+ uint8_t command;
+ uint8_t reserved;
+ uint16_t old_path_length;
+ uint16_t new_path_length;
+ // paths is two strings. The first is old_path and then a reserved byte.
+ // The last path is new_path.
+ uint8_t paths[];
+} __attribute__((packed));
+
+#define MOVE_STATUS 0x61
+struct move_status {
+ uint8_t command;
+ uint8_t status;
+} __attribute__((packed));
+
+#define STATUS_OK 0x01
+#define STATUS_ERROR 0x02
+#define STATUS_ERROR_NO_FILE 0x03
+#define STATUS_ERROR_PROTOCOL 0x04
+#define STATUS_ERROR_READONLY 0x05
+
+
+#endif // MICROPY_INCLUDED_SUPERVISOR_SHARED_BLUETOOTH_FILE_TRANSFER_PROTOCOL_H