# Porting Guide

Stratify OS is an operating system specifically designed for the ARM Cortex-M architecture. It supports the following architectures:

- ARM Cortex M3 (armv7m)
- ARM Cortex M4 (armv7em)
- ARM Cortex M4F (armv7em_f4sh)
- ARM Cortex M7 (armv7em_f5sh and armv7em_f5dh)

There is planned support for the ARM Cortex M23 and M33 architectures though no chips are currently supported.

# Configuration

Stratify OS is ported using link level configuration. Your board support package must provide the following variable symbols:

```c++
extern volatile sched_task_t sos_sched_table[];
extern volatile task_t sos_task_table[];
extern const sos_config_t sos_config;
```

The `sos_config_t` structure looks like this:

```c++
typedef struct MCU_PACK {
  sos_sys_config_t sys;
  sos_fs_config_t fs;
  sos_clock_config_t clock;
  sos_task_config_t task;
  sos_debug_config_t debug;
  sos_cache_config_t cache;
  sos_sleep_config_t sleep;
  sos_usb_config_t usb;
  const sos_socket_api_t *socket_api;
  void (*event_handler)(int, void *);
} sos_config_t;
```

The details of `sos_config_t` are listed in the [sos/config.h](../include/sos/config.h) header file. The code contains relevant comments for implementing the functionality.

There is a sample project for a collection of [Nucleo144 development boards](https://github.com/StratifyLabs/StratifyOS-Nucleo144) that is also a great resource for understanding how to port to your own board.