==========================================
    Programable State Machine (PSM)
==========================================

1. Описание характеристик генерируемого КА : 
--------------------------------------------
  
+--------------------------------------+--------------------------------------------+
| Кол-во входных условий               | 1000                                       |
+--------------------------------------+--------------------------------------------+
| Кол-во выходов                       | 64                                         |
+--------------------------------------+--------------------------------------------+
| Кол-во состояний                     | не ограниченно                             |
+--------------------------------------+--------------------------------------------+
| Глубина стека возвратов              |  1 [1]_                                    |
+--------------------------------------+--------------------------------------------+
| Типы выходов по способу кодирования  | комбинационные Мура/Мили, регистровые Мура |
+--------------------------------------+--------------------------------------------+
| Формат кодировния                    | onehot, native [2]_, sequental             |
+--------------------------------------+--------------------------------------------+

    .. [1] возможно увеличение за счет модернизации генератора
    .. [2] native - чистый последовательный формат описания КА с указанием всех переходов (квартус хорошо понимает только его)

2.Форматы вызова PSM : 
----------------------
    python psm.py [-o|-n] infile.psm 
           psm.py [-o|-n] infile.psm 

3.Описание используемой мнемоники 
---------------------------------

3.Описание используемой мнемоники 
---------------------------------
    .. note :: мнемоника ассемблера построена на основе мнемоники языка Verilog 

    
    
    3.0. Анализ файла :: 
        Однопроходный сверху вниз. 
        Все используемые макаросы, переменные, но не метки должны быть объявлены выше секции где они используються.

    3.1. Макросы :: 
    
        `define <имя макроса> <значениe макроса>

    Поддерживаются только однострочные макросы. При переопределении имени макроса будет ошибка. 
    Синтаксическая проверка макроса осуществляеться(обусловленно используемым способом анализа лексем !!! )
  
    3.2. Секции описания переменных::
    
      const 
        <имя переменной> = <значение переменной>; 
        <имя переменной> = <значение переменной>;
      endconst            
      branch 
        <имя перехода> = <значение перехода>; 
        <имя перехода> = <значение перехода>;
      endbranch 
    

    Наличие символа **';'** в конце строки назначения переменной обязательно.
    В переменных допускаются перекрестные ссылки. При переопределении имени переменной будет ошикбка. 
    Одинаковые имена для констант, переходов, макросов и меток не допускються
  
    3.3. Секции описания кода ::
    
      begin 
        исполняемый код конечного автомата 
      end   
      
    3.3.1. Формат комманд ::
    
        <Label :> <cmd> , <output> ;
        <Label :> <cmd> , <output> ;
        <Label :> if (<cond>) <cmd>, <output>; else <cmd>, <output>;
        <Label :> if (<cond>) <cmd>, <output>; elif (<cond>) <cmd>, output; else <cmd>, <output>;        
      
    Кол-во ветвлений не ограничено.     
    Команда может быть разбита на несколько строк, наличие символа ';' в конце команды обязательно.
    Значения выходов по времени, в независимости от способа кодирования и использумого вектора выходных сигналов, однозначно 
    соответствуют состоянию(адрессу микропрограммы) в котором находиться КА. 
         
    3.3.2. Форматы команд отвечающих за управление состоянием ::
    
        nop       : pc <= pc + 1
        wait      : pc <= pc
        jump addr : pc <= addr
        call addr : pc <= addr, pc_ret <= pc + 1
        ret       : pc <= pc_ret;
      
    Ссылка в командах jump и call на 'begin' приводит к неявной подстановке адреса холостого состояния
        
    3.3.3. Допустимые значения переходов :: 
    
        Идентификатор в пределах 'br0'...'br999'
        
    3.3.4. Допустимые значения констант :: 
      
        Любые 64 битные числа в 16-тиричном или 10-тичном форматах
      
    3.3.5. Формат описания обработки переходов <cond> 
      
    Допускается использование в описании перехода более одного имени/значения перехода. 
    Логические функции переходов
    
    +---+---------------+
    |'!'| отрицание     |
    +---+---------------+
    |'&'| логическое AND|
    +---+---------------+
    |'|'| логическое OR |
    +---+---------------+
    |'^'| логическое XOR|
    +---+---------------+
        
    3.3.6. Формат описания обработки выходов
    
    Допускаеться использование в описании выхода более одного имени константы/значения выхода    
    Арифметические функции выходов 
    
    +---+------------+
    |'+'| сложение   |
    +---+------------+
    |'-'| вычитаиние |
    +---+------------+
    
    Способы кодирования выходов Мили/Мура. Внимание "регистровые" выходы Мили на самом деле представляют собой регистровые one-hot 
    сигналы текущего состояния и комбинационная логика. 
    Генератор отслеживает карту использования выходных битов состояния и выбирает способ кодирования выходного бита.    
    
4. Коментарии :
---------------
  Однострочные. Любая строка начиная с символа **'//'**  
    
5. Формат выходного файла :
---------------------------
  <name>.v          - файл с описанием модуля КА на языке Verilog
  
  <name>_cmp.vo     - файл с инсталяцией модуля КА на языке Verilog
  
  <name>_cmo.vho    - файл с инсталяцией модуля КА на языке VHDL
  
6. Интерфейсы генерируемого КА. 

.. note:: Ширина вектора выходов и вектора переходов генерируемого КА определяеться автоматически.

    +-------+------------------------------+------------------------+
    | clk   | тактовая частота                                      |
    +-------+------------------------------+------------------------+
    | reset | асинхронный сброс                                     |
    +-------+------------------------------+------------------------+
    | sclr  | синхронный сброс                                      |
    +-------+------------------------------+------------------------+
    | br    | вектор сигналов перехода                              |
    +-------+------------------------------+------------------------+
    | outr  | регистровые выходы Мура и "регистровые" выходы Мили   |
    +-------+------------------------------+------------------------+
    | outc  | комбинационные выходы Мура/Мили                       |
    +-------+------------------------------+------------------------+