rainbow: added UDP_ADDR_POOL_* commands

- added UDP_ADDR_POOL_* commands
- updated command list
This commit is contained in:
contact@brokestudio.fr 2024-01-27 15:19:11 +01:00
parent 66d7a2bf8d
commit 36316ac1cd
4 changed files with 244 additions and 115 deletions

View File

@ -111,6 +111,12 @@ BrokeStudioFirmware::BrokeStudioFirmware()
this->default_server_settings_port = this->server_settings_port;
#endif
// Clear UDP address pool
for (size_t i = 0; i < 16; i++) {
this->ipAddressPool[i].ipAddress = "";
this->ipAddressPool[i].port = 0;
}
// Init fake registered networks
this->networks = {{
{"EMULATOR_SSID", "EMULATOR_PASS", true},
@ -280,10 +286,10 @@ void BrokeStudioFirmware::processBufferedMessage()
this->tx_messages.push_back({19, static_cast<uint8_t>(fromesp_cmds_t::ESP_FIRMWARE_VERSION), 17, 'E', 'M', 'U', 'L', 'A', 'T', 'O', 'R', '_', 'F', 'I', 'R', 'M', 'W', 'A', 'R', 'E'});
break;
case toesp_cmds_t::ESP_FACTORY_SETTINGS:
case toesp_cmds_t::ESP_FACTORY_RESET:
UDBG("[Rainbow] ESP received command ESP_FACTORY_SETTINGS\n");
UDBG("[Rainbow] ESP_FACTORY_SETTINGS has no use here\n");
this->tx_messages.push_back({2, static_cast<uint8_t>(fromesp_cmds_t::ESP_FACTORY_RESET), static_cast<uint8_t>(esp_factory_reset::ERROR_WHILE_RESETTING_CONFIG)});
this->tx_messages.push_back({2, static_cast<uint8_t>(fromesp_cmds_t::ESP_FACTORY_RESET), static_cast<uint8_t>(esp_factory_reset::ERROR_WHILE_SAVING_CONFIG)});
break;
case toesp_cmds_t::ESP_RESTART:
@ -470,15 +476,15 @@ void BrokeStudioFirmware::processBufferedMessage()
if (message_size == 2)
{
server_protocol_t requested_protocol = static_cast<server_protocol_t>(this->rx_buffer.at(2));
if (requested_protocol > server_protocol_t::UDP)
if (requested_protocol > server_protocol_t::UDP_POOL)
{
UDBG("[Rainbow] ESP SET_SERVER_PROTOCOL: unknown protocol (%u)\n", static_cast<unsigned int>(requested_protocol));
UDBG("[Rainbow] SERVER_SET_PROTOCOL: unknown protocol (%u)\n", static_cast<unsigned int>(requested_protocol));
}
else
{
if (requested_protocol == server_protocol_t::TCP_SECURED)
{
UDBG("[Rainbow] SET_SERVER_PROTOCOL: protocol TCP_SECURED not supported, falling back to TCP\n");
UDBG("[Rainbow] SERVER_SET_PROTOCOL: protocol TCP_SECURED not supported, falling back to TCP\n");
requested_protocol = server_protocol_t::TCP;
}
this->active_protocol = requested_protocol;
@ -601,6 +607,74 @@ void BrokeStudioFirmware::processBufferedMessage()
break;
}
// UDP ADDRESS POOL CMDS
case toesp_cmds_t::UDP_ADDR_POOL_CLEAR:
UDBG("[Rainbow] ESP received command UDP_ADDR_POOL_CLEAR");
for(size_t i = 0; i < 16; i++) {
this->ipAddressPool[i].ipAddress = "";
this->ipAddressPool[i].port = 0;
}
break;
case toesp_cmds_t::UDP_ADDR_POOL_ADD:
{
UDBG("[Rainbow] ESP received command UDP_ADDR_POOL_ADD");
int port =
(static_cast<uint16_t>(this->rx_buffer.at(2)) << 8) +
(static_cast<uint16_t>(this->rx_buffer.at(3)));
uint8_t len = this->rx_buffer.at(4);
if(len >= 16) break;
string ipAddress = string(this->rx_buffer.begin() + 5, this->rx_buffer.begin() + 5 + len);
for(size_t i = 0; i < 16; i++) {
if(this->ipAddressPool[i].ipAddress == ipAddress && this->ipAddressPool[i].port == port)
break;
}
for(size_t i = 0; i < 16; i++) {
if(this->ipAddressPool[i].ipAddress == "") {
this->ipAddressPool[i].ipAddress = ipAddress;
this->ipAddressPool[i].port = port;
break;
}
}
break;
}
case toesp_cmds_t::UDP_ADDR_POOL_REMOVE:
{
UDBG("[Rainbow] ESP received command UDP_ADDR_POOL_REMOVE");
int port =
(static_cast<uint16_t>(this->rx_buffer.at(2)) << 8) +
(static_cast<uint16_t>(this->rx_buffer.at(3)));
uint8_t len = this->rx_buffer.at(4);
if(len >= 16) break;
string ipAddress = string(this->rx_buffer.begin() + 5, this->rx_buffer.begin() + 5 + len);
for(size_t i = 0; i < 16; i++) {
if(this->ipAddressPool[i].ipAddress == ipAddress && this->ipAddressPool[i].port == port) {
this->ipAddressPool[i].ipAddress = "";
this->ipAddressPool[i].port = 0;
break;
}
}
break;
}
case toesp_cmds_t::UDP_ADDR_POOL_SEND_MSG:
{
UDBG("[Rainbow] ESP received command UDP_ADDR_POOL_SEND_MSG");
if (this->active_protocol == server_protocol_t::UDP_POOL) {
uint8_t const payload_size = static_cast<const uint8_t>(this->rx_buffer.size() - 2);
deque<uint8_t>::const_iterator payload_begin = this->rx_buffer.begin() + 2;
deque<uint8_t>::const_iterator payload_end = payload_begin + payload_size;
this->sendUdpDatagramToPool(payload_begin, payload_end);
}
break;
}
// NETWORK CMDS
// network commands are not relevant here, so we'll just use test/fake data
case toesp_cmds_t::NETWORK_SCAN:
@ -619,8 +693,8 @@ void BrokeStudioFirmware::processBufferedMessage()
NUM_FAKE_NETWORKS
});
break;
case toesp_cmds_t::NETWORK_GET_DETAILS:
UDBG("[Rainbow] ESP received command NETWORK_GET_DETAILS\n");
case toesp_cmds_t::NETWORK_GET_SCANNED_DETAILS:
UDBG("[Rainbow] ESP received command NETWORK_GET_SCANNED_DETAILS\n");
if (message_size == 2)
{
uint8_t networkItem = this->rx_buffer.at(2);
@ -938,10 +1012,10 @@ void BrokeStudioFirmware::processBufferedMessage()
{
if (this->working_file.active)
{
this->working_file.offset = this->rx_buffer.at(2);
if(message_size == 3) this->working_file.offset += this->rx_buffer.at(3) << 8;
if(message_size == 4) this->working_file.offset += this->rx_buffer.at(4) << 16;
if(message_size == 5) this->working_file.offset += this->rx_buffer.at(5) << 24;
this->working_file.offset = this->rx_buffer.at(2);
if(message_size == 3) this->working_file.offset += this->rx_buffer.at(3) << 8;
if(message_size == 4) this->working_file.offset += this->rx_buffer.at(4) << 16;
if(message_size == 5) this->working_file.offset += this->rx_buffer.at(5) << 24;
}
}
break;
@ -1818,6 +1892,59 @@ void BrokeStudioFirmware::sendUdpDatagramToServer(I begin, I end)
}
}
template<class I>
void BrokeStudioFirmware::sendUdpDatagramToPool(I begin, I end)
{
#if RAINBOW_DEBUG_ESP >= 1
FCEU_printf("RAINBOW %lu udp datagram to send", wall_clock_milli());
#if RAINBOW_DEBUG_ESP >= 2
FCEU_printf(": ");
for (I cur = begin; cur < end; ++cur)
{
FCEU_printf("%02x ", *cur);
}
#endif
FCEU_printf("\n");
#endif
if(this->udp_socket == -1) return;
size_t message_size = end - begin;
vector<uint8_t> aggregated;
aggregated.reserve(message_size);
aggregated.insert(aggregated.end(), begin, end);
for(size_t i = 0; i < 16; i++) {
if(this->ipAddressPool[i].ipAddress != "") {
// Init UDP socket and store parsed address
std::pair<bool, sockaddr> res_dest_addr = this->resolve_address(this->ipAddressPool[i].ipAddress, this->ipAddressPool[i].port);
if(!res_dest_addr.first) {
continue;
}
sockaddr dest_addr = res_dest_addr.second;
ssize_t n = sendto(
this->udp_socket, cast_network_payload(aggregated.data()), static_cast<int>(aggregated.size()), 0,
&dest_addr, sizeof(sockaddr)
);
if(n == -1) {
#ifdef _WIN32
char errmsg[ERR_MSG_SIZE];
errno_t r = strerror_s(errmsg, ERR_MSG_SIZE, errno);
UDBG("[Rainbow] UDP send failed: %s\n", string(errmsg));
#else
UDBG("[Rainbow] UDP send failed: %s\n", strerror(errno));
#endif
} else if(static_cast<size_t>(n) != message_size) {
UDBG("[Rainbow] UDP sent partial message");
}
}
}
}
template <class I>
void BrokeStudioFirmware::sendTcpDataToServer(I begin, I end)
{
@ -1978,12 +2105,12 @@ void BrokeStudioFirmware::openConnection()
if (this->active_protocol == server_protocol_t::TCP)
{
// Resolve server's hostname
// std::pair<bool, sockaddr_in> server_addr = this->resolve_server_address();
std::pair<bool, sockaddr> server_addr = this->resolve_server_address();
if (!server_addr.first)
std::pair<bool, sockaddr> res_server_addr = this->resolve_address(this->server_settings_address, this->server_settings_port);
if (!res_server_addr.first)
{
return;
}
this->server_addr = res_server_addr.second;
// Create socket
this->tcp_socket = ::socket(AF_INET, SOCK_STREAM, 0);
@ -1998,7 +2125,7 @@ void BrokeStudioFirmware::openConnection()
}
// Connect to server
int connect_res = ::connect(this->tcp_socket, &server_addr.second, sizeof(sockaddr));
int connect_res = ::connect(this->tcp_socket, &this->server_addr, sizeof(sockaddr));
if (connect_res == -1)
{
#ifdef _WIN32
@ -2015,16 +2142,17 @@ void BrokeStudioFirmware::openConnection()
// TODO
UDBG("[Rainbow] TCP_SECURED not yet implemented");
}
else if (this->active_protocol == server_protocol_t::UDP)
else if(this->active_protocol == server_protocol_t::UDP || this->active_protocol == server_protocol_t::UDP_POOL)
{
// Init UDP socket and store parsed address
// std::pair<bool, sockaddr_in> server_addr = this->resolve_server_address();
std::pair<bool, sockaddr> server_addr = this->resolve_server_address();
if (!server_addr.first)
{
return;
if(this->active_protocol == server_protocol_t::UDP) {
// Init UDP socket and store parsed address
std::pair<bool, sockaddr> res_server_addr = this->resolve_address(this->server_settings_address, this->server_settings_port);
if (!res_server_addr.first)
{
return;
}
this->server_addr = res_server_addr.second;
}
this->server_addr = server_addr.second;
this->udp_socket = ::socket(AF_INET, SOCK_DGRAM, 0);
if (this->udp_socket == -1)
@ -2126,8 +2254,7 @@ void BrokeStudioFirmware::receivePingResult()
});
}
// std::pair<bool, sockaddr_in> BrokeStudioFirmware::resolve_server_address()
std::pair<bool, sockaddr> BrokeStudioFirmware::resolve_server_address()
std::pair<bool, sockaddr> BrokeStudioFirmware::resolve_address(string address, uint16_t port)
{
// Resolve IP address for hostname
bool result = false;
@ -2138,9 +2265,9 @@ std::pair<bool, sockaddr> BrokeStudioFirmware::resolve_server_address()
sockaddr sa;
memset(&sa, 0, sizeof(sa));
if (getaddrinfo(this->server_settings_address.c_str(), std::to_string(this->server_settings_port).c_str(), &hint, &addrInfo) != 0)
if (getaddrinfo(address.c_str(), std::to_string(port).c_str(), &hint, &addrInfo) != 0)
{
UDBG("[Rainbow] Unable to resolve server's hostname (%s:%s)\n", this->server_settings_address.c_str(), std::to_string(this->server_settings_port).c_str());
UDBG("[Rainbow] Unable to resolve server's hostname (%s:%s)\n", address.c_str(), std::to_string(port).c_str());
}
else
{
@ -2150,25 +2277,6 @@ std::pair<bool, sockaddr> BrokeStudioFirmware::resolve_server_address()
freeaddrinfo(addrInfo);
return std::make_pair(result, sa);
/*
sockaddr_in addr;
hostent *he = gethostbyname(this->server_settings_address.c_str());
if (he == NULL) {
UDBG("[Rainbow] unable to resolve server's hostname\n");
::memset(&addr, 0, sizeof(addr));
return std::make_pair(false, addr);
}
bzero(reinterpret_cast<void*>(&addr), sizeof(addr));
addr.sin_family = AF_INET;
addr.sin_port = htons(this->server_settings_port);
addr.sin_addr = *((in_addr*)he->h_addr);
return std::make_pair(true, addr);
*/
}
namespace

View File

@ -12,17 +12,17 @@
#include <thread>
#include <fstream>
using std::pair;
using std::array;
using std::vector;
using std::min;
using std::max;
using std::ifstream;
using std::ofstream;
using std::string;
using std::atomic;
using std::thread;
using std::deque;
using std::ifstream;
using std::max;
using std::min;
using std::ofstream;
using std::pair;
using std::string;
using std::thread;
using std::vector;
#ifdef _WIN32
#include <winsock2.h>
@ -80,6 +80,12 @@ struct WorkingFile
FileStruct *file;
};
struct UPDpoolAddress
{
string ipAddress;
uint16_t port;
};
class BrokeStudioFirmware
{
public:
@ -96,73 +102,79 @@ private:
enum class toesp_cmds_t : uint8_t
{
// ESP CMDS
ESP_GET_STATUS,
DEBUG_GET_LEVEL,
DEBUG_SET_LEVEL,
DEBUG_LOG,
BUFFER_CLEAR_RX_TX,
BUFFER_DROP_FROM_ESP,
ESP_GET_FIRMWARE_VERSION,
ESP_FACTORY_SETTINGS,
ESP_RESTART,
ESP_GET_STATUS = 0, // 0x00
DEBUG_GET_LEVEL = 1, // 0x01
DEBUG_SET_LEVEL = 2, // 0x02
DEBUG_LOG = 3, // 0x03
BUFFER_CLEAR_RX_TX = 4, // 0x04
BUFFER_DROP_FROM_ESP = 5, // 0x05
ESP_GET_FIRMWARE_VERSION = 6, // 0x06
ESP_FACTORY_RESET = 7, // 0x07
ESP_RESTART = 8, // 0x08
// WIFI CMDS
WIFI_GET_STATUS,
WIFI_GET_SSID,
WIFI_GET_IP,
WIFI_GET_CONFIG,
WIFI_SET_CONFIG,
WIFI_GET_STATUS = 9, // 0x09
WIFI_GET_SSID = 10, // 0x0A
WIFI_GET_IP = 11, // 0x0B
WIFI_GET_CONFIG = 12, // 0x0C
WIFI_SET_CONFIG = 13, // 0x0D
// AP CMDS
AP_GET_SSID,
AP_GET_IP,
// ACCESS POINT CMDS
AP_GET_SSID = 14, // 0x0E
AP_GET_IP = 15, // 0x0F
// RND CMDS
RND_GET_BYTE,
RND_GET_BYTE_RANGE, // ; min / max
RND_GET_WORD,
RND_GET_WORD_RANGE, // ; min / max
RND_GET_BYTE = 16, // 0x10
RND_GET_BYTE_RANGE = 17, // 0x11
RND_GET_WORD = 18, // 0x12
RND_GET_WORD_RANGE = 19, // 0x13
// SERVER CMDS
SERVER_GET_STATUS,
SERVER_PING,
SERVER_SET_PROTOCOL,
SERVER_GET_SETTINGS,
SERVER_SET_SETTINGS,
SERVER_GET_SAVED_SETTINGS,
SERVER_SET_SAVED_SETTINGS,
SERVER_RESTORE_SAVED_SETTINGS,
SERVER_CONNECT,
SERVER_DISCONNECT,
SERVER_SEND_MSG,
SERVER_GET_STATUS = 20, // 0x14
SERVER_PING = 21, // 0x15
SERVER_SET_PROTOCOL = 22, // 0x16
SERVER_GET_SETTINGS = 23, // 0x17
SERVER_SET_SETTINGS = 24, // 0x18
SERVER_GET_SAVED_SETTINGS = 25, // 0x19
SERVER_SET_SAVED_SETTINGS = 26, // 0x1A
SERVER_RESTORE_SAVED_SETTINGS = 27, // 0x1B
SERVER_CONNECT = 28, // 0x1C
SERVER_DISCONNECT = 29, // 0x1D
SERVER_SEND_MSG = 30, // 0x1E
// UDP ADDRESS POOL CMDS
UDP_ADDR_POOL_CLEAR = 55, // 0x37
UDP_ADDR_POOL_ADD = 56, // 0x38
UDP_ADDR_POOL_REMOVE = 57, // 0x39
UDP_ADDR_POOL_SEND_MSG = 58, // 0x3A
// NETWORK CMDS
NETWORK_SCAN,
NETWORK_GET_SCAN_RESULT,
NETWORK_GET_DETAILS,
NETWORK_GET_REGISTERED,
NETWORK_GET_REGISTERED_DETAILS,
NETWORK_REGISTER,
NETWORK_UNREGISTER,
NETWORK_SET_ACTIVE,
NETWORK_SCAN = 31, // 0x1F
NETWORK_GET_SCAN_RESULT = 32, // 0x20
NETWORK_GET_SCANNED_DETAILS = 33, // 0x21
NETWORK_GET_REGISTERED = 34, // 0x22
NETWORK_GET_REGISTERED_DETAILS = 35, // 0x23
NETWORK_REGISTER = 36, // 0x24
NETWORK_UNREGISTER = 37, // 0x25
NETWORK_SET_ACTIVE = 38, // 0x26
// FILE CMDS
FILE_OPEN,
FILE_CLOSE,
FILE_STATUS,
FILE_EXISTS,
FILE_DELETE,
FILE_SET_CUR,
FILE_READ,
FILE_WRITE,
FILE_APPEND,
FILE_COUNT,
FILE_GET_LIST,
FILE_GET_FREE_ID,
FILE_GET_FS_INFO,
FILE_GET_INFO,
FILE_DOWNLOAD,
FILE_FORMAT,
FILE_OPEN = 39, // 0x27
FILE_CLOSE = 40, // 0x28
FILE_STATUS = 41, // 0x29
FILE_EXISTS = 42, // 0x2A
FILE_DELETE = 43, // 0x2B
FILE_SET_CUR = 44, // 0x2C
FILE_READ = 45, // 0x2D
FILE_WRITE = 46, // 0x2E
FILE_APPEND = 47, // 0x2F
FILE_COUNT = 48, // 0x30
FILE_GET_LIST = 49, // 0x31
FILE_GET_FREE_ID = 50, // 0x32
FILE_GET_FS_INFO = 51, // 0x33
FILE_GET_INFO = 52, // 0x34
FILE_DOWNLOAD = 53, // 0x35
FILE_FORMAT = 54, // 0x36
};
// Defined message types from ESP to CPU
@ -213,16 +225,17 @@ private:
enum class esp_factory_reset : uint8_t
{
SUCCESS = 0,
ERROR_WHILE_RESETTING_CONFIG = 1,
ERROR_WHILE_SAVING_CONFIG = 1,
ERROR_WHILE_DELETING_TWEB = 2,
ERROR_WHILE_DELETING_WEB = 3
};
enum class server_protocol_t : uint8_t
{
TCP,
TCP_SECURED,
UDP,
TCP = 0,
TCP_SECURED = 1,
UDP = 2,
UDP_POOL = 3,
};
// WIFI_CONFIG
@ -296,6 +309,8 @@ private:
template <class I>
void sendUdpDatagramToServer(I begin, I end);
template <class I>
void sendUdpDatagramToPool(I begin, I end);
template <class I>
void sendTcpDataToServer(I begin, I end);
void receiveDataFromServer();
@ -305,7 +320,7 @@ private:
void pingRequest(uint8_t n);
void receivePingResult();
pair<bool, sockaddr> resolve_server_address();
pair<bool, sockaddr> resolve_address(string address, uint16_t port);
static deque<uint8_t> read_socket(int socket);
void initDownload();
@ -331,6 +346,8 @@ private:
string server_settings_address;
uint16_t server_settings_port = 0;
UPDpoolAddress ipAddressPool[16];
uint8_t debug_config = 0;
uint8_t wifi_config = 1;

View File

@ -1022,6 +1022,7 @@ xcopy /y /d "$(ProjectDir)\..\src\drivers\win\7z_64.dll" "$(OutDir)"</Command>
</ItemGroup>
<ItemGroup>
<ClInclude Include="..\src\asm.h" />
<ClInclude Include="..\src\boards\rainbow_esp.h" />
<ClInclude Include="..\src\boards\RNBW\pping.h" />
<ClInclude Include="..\src\cart.h" />
<ClInclude Include="..\src\cheat.h" />

View File

@ -1650,6 +1650,9 @@
<ClInclude Include="..\src\debugsymboltable.h" />
<ClInclude Include="..\src\ld65dbg.h" />
<ClInclude Include="..\src\utils\mutex.h" />
<ClInclude Include="..\src\boards\rainbow_esp.h">
<Filter>boards</Filter>
</ClInclude>
</ItemGroup>
<ItemGroup>
<ResourceCompile Include="..\src\drivers\win\res.rc">