Model for the network stack

Class diagram

A preliminary class diagram can be found in at here:

https://drive.google.com/file/d/0Bw4T8Mqih7-oc2FpN01pMmVPQ0E/view

(can be opened at with the web application draw.io

Use-cases

Use cases for the network stack

(partly modeled as sequence diagrams at https://drive.google.com/file/d/0Bw4T8Mqih7-oa3VYeFpWMW9zeHM/view?usp=sharing)

Initialize network device

• Use case ID: net0001
• Application: RIOT network stack
• Use case descripiton: Initialize a network device
• Primary actor: network device driver
• Precondition: network device and network device driver is known
• Trigger: initialization program of network device driver is started
• Basic flow:
  1. network device driver receives network device
  2. network device driver sets driver of network device to network device driver appropriatly
  3. network device driver sets initial state
  4. network device driver sets initial option values
• Alternate flow: —

Register receive callback to network device driver

• Use case ID: net0002
• Application: RIOT network stack
• Use case descripiton: Registers a receive callback to the network device driver to allow for further handling of received data
• Primary actor: network device driver
• Precondition:
  • receive callback is defined
  • network device is initialized (net0001)
• Trigger: registration program of network device driver is started
• Basic flow:
  1. network device driver receives receive callback
  2. network device driver checks if space is available to register receive callback
  3. if so network device driver registers receive callback to itself
• Alternate flow:
  1. network device driver receives receive callback
  2. network device driver checks if space is available to register receive callback
  3. if not network device driver inform caller about unavailable space

Unregister receive callback from network device driver

• Use case ID: net0003
• Application: RIOT network stack
• Use case description: Unregister a receive callback to the network device driver to prevent further handling of received data as defined by the callback
• Primary actor: network device driver
• Precondition:
  • receive callback is defined
  • network device is initialized (net0001)
• Trigger: unregistration program of network device driver is started
• Basic flow:
  1. network device driver receives receive callback
  2. network device driver checks if receive callback is registered
  3. if so network device driver removes receive callback from its registry
• Alternate flow:
  1. network device driver receives receive callback
  2. network device driver checks if receive callback is registered
  3. if not network device driver disregards call silently

Receive packet from hardware

• Use case ID: net0004
• Application: RIOT network stack
• Use case descripiton: RIOT receives a packet from network device via SPI or similar device
• Primary actor: network device driver
• Precondition:
  • at least one receive callback to network device driver (net0002)
  • network device driver knows ID of receive event from network device
  • Packet buffer is initialized
• Trigger: Network device sends message of type NETDEV_MSG_EVENT_TYPE to MAC layer to inform about received packet
• Basic flow:
  1. MAC layer notifies event back to network device driver
  2. Network device driver identifies event as receive event
  3. Network device driver copies received data from network device buffer into packet buffer
  4. Network device driver calls receive callbacks
• Alternate flow: —

Send packet to hardware

• Use case ID: net0005
• Application: RIOT network stack
• Use case descripiton: RIOT sends a packet to network device
• Primary actor: network device driver
• Precondition:
  • Packet buffer is initialized
  • Packet is in packet buffer Packet buffer
  • network device is initialized (net0001)
• Trigger: send program of network device driver is started
• Basic flow:
  1. Network device driver checks destination address length and payload length and they are correct
  2. Network device driver sends radio's header
  3. Network device driver iterates over Packet headers and sends them in-order
  4. Network device driver sends payload data
• Alternate flow:
  • Address length not supported:
    1. Network device driver checks destination address length and payload length and destination address length not supported
    2. Network device driver inform caller that address length is not supported
  • Data length not supported:
    1. Network device driver checks destination address length and payload length and data length not supported
    2. Network device driver inform caller that data length is not supported

Get device option

• Use case ID: net0006
• Application: RIOT network stack
• Use case description: Get an option from the network device (e.g. radio channel)
• Primary actor: network device driver
• Precondition:
  • network device is initialized (net0001)
• Trigger: get option program of network device driver is started
• Basic flow:
  1. Network device driver checks if option type is supported
  2. if so: network device driver checks available space in given value buffer
  3. if long enough: network device driver resets length of given value buffer to actual length of value
  4. network device driver copies value data into value buffer
• Alternate flow:
  • option type is not supported:
    1. Network device driver checks if option type is supported
    2. if not: network device driver signals that option type is not supported to caller
  • available space in given value buffer is not long enough
    1. Network device driver checks if option type is supported
    2. if so: network device driver checks available space in given value buffer
    3. if too short: network device driver signals to caller that value buffer space is too short

Set device option

• Use case ID: net0007
• Application: RIOT network stack
• Use case description: Set an option to the network device (e.g. radio channel)
• Primary actor: network device driver
• Precondition:
  • network device is initialized (net0001)
• Trigger: set option program of network device driver is started
• Basic flow:
  1. Network device driver checks if option type is supported
  2. if so: network device driver checks length of given value buffer
  3. if short enough: network device driver copies data from value buffer to option register
• Alternate flow:
  • option type is not supported:
    1. Network device driver checks if option type is supported
    2. if not: network device driver signals that option type is not supported to caller
  • length of given value buffer is too long
    1. Network device driver checks if option type is supported
    2. if so: network device driver checks length of given value buffer
    3. if too long: network device driver signals to caller that value in value buffer would overflow

Get device state

• Use case ID: net0008
• Application: RIOT network stack
• Use case description: Get state from the network device (e.g. low-power mode)
• Primary actor: network device driver
• Precondition:
  • network device is initialized (net0001)
• Trigger: get state program of network device driver is started
• Basic flow:
  1. network device driver returns current state
• Alternate flow: —

Set device state

• Use case ID: net0009
• Application: RIOT network stack
• Use case description: Set state from the network device (e.g. low-power mode)
• Primary actor: network device driver
• Precondition:
  • network device is initialized (net0001)
• Trigger: set state program of network device driver is started
• Basic flow:
  1. network device driver checks if given state is supported
  2. if so: network device driver sets new state of device
• Alternate flow:
  1. network device driver checks if given state is supported
  2. if not: network device driver signals to caller