12 |
17 | OCaml package documentation
13 |-
14 |
- fsml 15 |
Fsml__BuiltinsBuiltin environments
val typing_env : (string * Fsml.Types.typ_scheme) listval eval_env : (string * Fsml.Expr.e_val) listFsml.Builtinsval typing_env : (string * Types.typ_scheme) listval eval_env : (string * Expr.e_val) listFsml__Tevents.OpsTevents.OpsFsml__Fsm_lexerval keyword_table : (string * Fsml.Fsm_parser.token) listval __ocaml_lex_tables : Stdlib.Lexing.lex_tablesval main : Stdlib.Lexing.lexbuf -> Fsml.Fsm_parser.tokenval __ocaml_lex_main_rec : Stdlib.Lexing.lexbuf -> int -> Fsml.Fsm_parser.tokenFsml.Fsm_lexerval keyword_table : (string * Fsm_parser.token) listval __ocaml_lex_tables : Stdlib.Lexing.lex_tablesval main : Stdlib.Lexing.lexbuf -> Fsm_parser.tokenval __ocaml_lex_main_rec : Stdlib.Lexing.lexbuf -> int -> Fsm_parser.tokenFsml__Eventtype t = Fsml.Expr.ident * Fsml.Expr.e_val(id,v) means that input, output or local variable id take value v
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringval to_string : t -> stringFsml__Vcdval write : fname:string -> fsm:Fsml.Fsm.t -> Fsml.Tevents.t list -> unitwrite ~fname:file ~fsm:f evs writes a representation of a list of timed events sets evs, for FSM f in VCD (Value Change Dump) format in file file.
val view : ?fname:string -> ?cmd:string -> fsm:Fsml.Fsm.t -> Fsml.Tevents.t list -> intview m evs views a simulation result for FSM m by first writing a .vcd file and then launching a VCD viewer application. The name of the output file and of the viewer application can be changed using the fname and cmd optional arguments. Returns the issued command exit status.
Fsml.Eventtype t = Expr.ident * Expr.e_val(id,v) means that input, output or local variable id take value v
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringval to_string : t -> stringFsml.Vcdval write : fname:string -> fsm:Fsm.t -> Tevents.t list -> unitwrite ~fname:file ~fsm:f evs writes a representation of a list of timed events sets evs, for FSM f in VCD (Value Change Dump) format in file file.
val view : ?fname:string -> ?cmd:string -> fsm:Fsm.t -> Tevents.t list -> intview m evs views a simulation result for FSM m by first writing a .vcd file and then launching a VCD viewer application. The name of the output file and of the viewer application can be changed using the fname and cmd optional arguments. Returns the issued command exit status.
Fsml__Clockval pp_clk : Ppx_deriving_runtime.Format.formatter -> clk -> Ppx_deriving_runtime.unitval show_clk : clk -> Ppx_deriving_runtime.stringtype 'a clocked = clk * 'aval pp_clocked : (Ppx_deriving_runtime.Format.formatter -> 'a -> Ppx_deriving_runtime.unit) -> Ppx_deriving_runtime.Format.formatter -> 'a clocked -> Ppx_deriving_runtime.unitval show_clocked : (Ppx_deriving_runtime.Format.formatter -> 'a -> Ppx_deriving_runtime.unit) -> 'a clocked -> Ppx_deriving_runtime.stringFsml.Clockval pp_clk : Ppx_deriving_runtime.Format.formatter -> clk -> Ppx_deriving_runtime.unitval show_clk : clk -> Ppx_deriving_runtime.stringtype 'a clocked = clk * 'aval pp_clocked : (Ppx_deriving_runtime.Format.formatter -> 'a -> Ppx_deriving_runtime.unit) -> Ppx_deriving_runtime.Format.formatter -> 'a clocked -> Ppx_deriving_runtime.unitval show_clocked : (Ppx_deriving_runtime.Format.formatter -> 'a -> Ppx_deriving_runtime.unit) -> 'a clocked -> Ppx_deriving_runtime.stringFsml__Seqmodeltype t = {m_name : string; | |
m_states : (string * Fsml.Valuation.t) list; | |
m_inps : (string * Fsml.Types.t) list; | |
m_outps : (string * Fsml.Types.t) list; | |
m_vars : (string * Fsml.Types.t) list; | |
m_init : Fsml.State.t * Fsml.Action.t list; | Initial transition |
m_body : (Fsml.State.t * Fsml.Transition.t list) list; | Transitions, indexed by source state |
}val make : Fsml.Fsm.t -> tmake f builds a sequential model from FSM f. The FSM is first type-checked.
Fsml__Ctype config = {mutable state_var : string; | Name of variable storing the current state (default: |
mutable incl_file : string; | Name of the support include file (default: |
}val cfg : configval write : ?dir:string -> prefix:string -> Fsml.Fsm.t -> unitwrite prefix m writes in files prefix.h and prefix.c a representation of FSM m as a C function. This function has prototype void fsm_xxx(ctx_t *ctx), where xxx is m.m_id and ctx_t is the type of a structure recording the value of inputs and outputs of the machine. Each call to the fsm_xxx function will correspond to one execution step of the machine: it first looks for a fireable transition (depending on the values of the inputs read in the context ctx and of the local variables) and, if found, performs the action associated to this transition (updating the value of outputs and local variables) and updates the current state. The generated files are written in the current working directory unless a target directory is specified with the dir argument. If the target directory does not exist, an attempt is made to create it.
Fsml.Seqmodeltype t = {m_name : string; | |
m_states : (string * Valuation.t) list; | |
m_inps : (string * Types.t) list; | |
m_outps : (string * Types.t) list; | |
m_vars : (string * Types.t) list; | |
m_init : State.t * Action.t list; | Initial transition |
m_body : (State.t * Transition.t list) list; | Transitions, indexed by source state |
}Fsml__Actiontype t = | Assign of Fsml.Expr.ident * Fsml.Expr.t |
The type of actions associated to FSM transitions
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringval to_yojson : t -> Yojson.Safe.tval of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_orval to_string : t -> stringval perform : Fsml.Expr.env -> t -> Fsml.Event.t listperform env a performs action a in the context of environment env returning a list of resulting events.
Fsml.Ctype config = {mutable state_var : string; | Name of variable storing the current state (default: |
mutable incl_file : string; | Name of the support include file (default: |
}val cfg : configval write : ?dir:string -> prefix:string -> Fsm.t -> unitwrite prefix m writes in files prefix.h and prefix.c a representation of FSM m as a C function. This function has prototype void fsm_xxx(ctx_t *ctx), where xxx is m.m_id and ctx_t is the type of a structure recording the value of inputs and outputs of the machine. Each call to the fsm_xxx function will correspond to one execution step of the machine: it first looks for a fireable transition (depending on the values of the inputs read in the context ctx and of the local variables) and, if found, performs the action associated to this transition (updating the value of outputs and local variables) and updates the current state. The generated files are written in the current working directory unless a target directory is specified with the dir argument. If the target directory does not exist, an attempt is made to create it.
Fsml__Dottype options = {mutable node_shape : string; |
mutable node_style : string; |
mutable rankdir : string; |
mutable layout : string; |
mutable mindist : float; |
}val default_options : optionsval write : string -> ?options:options -> Fsml.Fsm.t -> unitwrite fname m writes a .dot representation of FSM m in file fname. Rendering can be modified with the options optional argument.
val view : ?options:options -> ?fname:string -> ?cmd:string -> Fsml.Fsm.t -> intview m views FSM m by first writing its .dot representation in file and then launching a DOT viewer application. The name of the output file and of the viewer application can be changed using the fname and cmd optional arguments. Returns the issued command exit status.
Fsml__Guardtype t = Fsml.Expr.tThe type of guards associated to transitions. Guards are just boolean expressions.
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringval to_yojson : t -> Yojson.Safe.tval of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_orval to_string : Fsml.Expr.t -> stringexception Illegal_guard_expr of Fsml.Expr.tval eval : Fsml.Expr.env -> Fsml.Expr.t -> booleval env e evaluates guard expression e in environment env, returning the corresponding boolean value. Raises Illegal_guard_expr if the expression does not denote a boolean value.
Fsml.Actiontype t = | Assign of Expr.ident * Expr.t |
The type of actions associated to FSM transitions
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringval to_yojson : t -> Yojson.Safe.tval of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_orval to_string : t -> stringFsml.Guardtype t = Expr.tThe type of guards associated to transitions. Guards are just boolean expressions.
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringval to_yojson : t -> Yojson.Safe.tval of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_orval to_string : Expr.t -> stringexception Illegal_guard_expr of Expr.tFsml.Dottype options = {mutable node_shape : string; |
mutable node_style : string; |
mutable rankdir : string; |
mutable layout : string; |
mutable mindist : float; |
}val default_options : optionsval write : string -> ?options:options -> Fsm.t -> unitwrite fname m writes a .dot representation of FSM m in file fname. Rendering can be modified with the options optional argument.
val view : ?options:options -> ?fname:string -> ?cmd:string -> Fsm.t -> intview m views FSM m by first writing its .dot representation in file and then launching a DOT viewer application. The name of the output file and of the viewer application can be changed using the fname and cmd optional arguments. Returns the issued command exit status.
Fsml__Transitiontype t = Fsml.State.t * Fsml.Guard.t list * Fsml.Action.t list * Fsml.State.t(src,guards,actions,dst) means that the FSM will go from state src to state dst whenever all guards listed in guards evaluate to true, performing, sequentially, all actions listed in actions.
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringval to_yojson : t -> Yojson.Safe.tval of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_orval to_string : t -> stringval is_fireable : Fsml.State.t -> Fsml.Expr.env -> t -> boolis_fireable src env t returns true iff transition t is fireable when the enclosing FSM is in state state and the inputs and local variables have values recorded in environment env.
Fsml.Transitiontype t = State.t * Guard.t list * Action.t list * State.t(src,guards,actions,dst) means that the FSM will go from state src to state dst whenever all guards listed in guards evaluate to true, performing, sequentially, all actions listed in actions.
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringval to_yojson : t -> Yojson.Safe.tval of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_orval to_string : t -> stringFsml__Teventstype t = Fsml.Event.t list Fsml.Clock.clockedA timed event set (TES) is a list of events occuring at a given clock cycle. Example 4, [x:=1,y:=1] means that both x and y take value 1 at clock cycle 4. TES are used by simulator both to represent input stimuli and output events
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringmodule Ops : sig ... endval merge : t list list -> t listmerge [st1; ...: stn] merges n sequences of TES wrt. clock cycles. In other words, merge [l1; l2; ...; ln] is l1 @@@ l2 @@@ ... @@@ ln.
val changes : string -> Fsml.Expr.e_val Fsml.Clock.clocked list -> t listchanges name vcs builds a list of TES from a list vcs of value changes related to signal name, a value change being a pair of the clk cycle and a value. Ex: changes "x" [0,Int 1; 2,Int 0] is [0,[x:=1]; 2,[x:=0]].
val to_string : t -> stringFsml.Teventstype t = Event.t list Clock.clockedA timed event set (TES) is a list of events occuring at a given clock cycle. Example 4, [x:=1,y:=1] means that both x and y take value 1 at clock cycle 4. TES are used by simulator both to represent input stimuli and output events
val pp : Ppx_deriving_runtime.Format.formatter -> t -> Ppx_deriving_runtime.unitval show : t -> Ppx_deriving_runtime.stringmodule Ops : sig ... endval merge : t list list -> t listmerge [st1; ...: stn] merges n sequences of TES wrt. clock cycles. In other words, merge [l1; l2; ...; ln] is l1 @@@ l2 @@@ ... @@@ ln.
val changes : string -> Expr.e_val Clock.clocked list -> t listchanges name vcs builds a list of TES from a list vcs of value changes related to signal name, a value change being a pair of the clk cycle and a value. Ex: changes "x" [0,Int 1; 2,Int 0] is [0,[x:=1]; 2,[x:=0]].
val to_string : t -> stringFsml.Typingtype env = (string * Types.typ_scheme) listTyping environment
val type_check_fsm : ?mono:bool -> Fsm.t -> Fsm.ttype_check_fsm f type checks FSM f, raising !Typing_error when appropriate. Setting the optional mono argument also checks that all types occuring in the FSM definitions are monomorphic. This is required, for instance to generate C or VHDL code.
val type_check_fsm_guard : ?mono:bool -> ?with_clk:bool -> Fsm.t -> Guard.t -> Guard.ttype_check_fsm_guard f e type checks guard expression e in the context of FSM f. As for type_check_fsm, setting the mono optional argument also checks that all involved types are monomorphic. Setting the with_clk optional argument adds a variable named clk (with type int) to the typing environment.
val type_check_fsm_action : ?mono:bool -> Fsm.t -> Action.t -> Action.ttype_check_fsm_action f a type checks action a in the context of FSM f. As for type_check_fsm, passing the mono optional argument also checks that all involved types are monomorphic.
val type_check_stimuli : Fsm.t -> Tevents.t list -> Tevents.t listtype_check_stimuli f s type checks a sequence s of stimuli for a FSM f, raising !Typing_error when appropriate (for example if an event e refers to a non-existent input of f or if the type of value asssociated to e does not match the type of the corresponding input in f.
Fsml__TypingTyping
type env = (string * Fsml.Types.typ_scheme) listTyping environment
val type_check_fsm : ?mono:bool -> Fsml.Fsm.t -> Fsml.Fsm.ttype_check_fsm f type checks FSM f, raising !Typing_error when appropriate. Setting the optional mono argument also checks that all types occuring in the FSM definitions are monomorphic. This is required, for instance to generate C or VHDL code.
val type_check_fsm_guard : ?mono:bool -> ?with_clk:bool -> Fsml.Fsm.t -> Fsml.Guard.t -> Fsml.Guard.ttype_check_fsm_guard f e type checks guard expression e in the context of FSM f. As for type_check_fsm, setting the mono optional argument also checks that all involved types are monomorphic. Setting the with_clk optional argument adds a variable named clk (with type int) to the typing environment.
val type_check_fsm_action : ?mono:bool -> Fsml.Fsm.t -> Fsml.Action.t -> Fsml.Action.ttype_check_fsm_action f a type checks action a in the context of FSM f. As for type_check_fsm, passing the mono optional argument also checks that all involved types are monomorphic.
val type_check_stimuli : Fsml.Fsm.t -> Fsml.Tevents.t list -> Fsml.Tevents.t listtype_check_stimuli f s type checks a sequence s of stimuli for a FSM f, raising !Typing_error when appropriate (for example if an event e refers to a non-existent input of f or if the type of value asssociated to e does not match the type of the corresponding input in f.
Fsml__Miscval string_of_list : f:('a -> string) -> sep:string -> 'a list -> stringval iter_fst : (bool -> 'a -> unit) -> 'a list -> unitval list_make : f:(int -> 'a) -> lo:int -> hi:int -> 'a listval flat_map : ('a -> 'b list) -> 'a list -> 'b listval cart_prod : 'a list -> 'b list -> ('a * 'b) listval list_parse : parse_item:(Stdlib.Genlex.token Stdlib.Stream.t -> 'a) -> sep:string -> Stdlib.Genlex.token Stdlib.Stream.t -> 'a listval string_of_opt : ('a -> string) -> 'a option -> stringval bit_size : int -> intval pow2 : int -> intval quote_string : string -> stringval check_dir : string -> unitval spaces : int -> stringval replace_assoc : 'a -> 'b -> ('a * 'b) list -> ('a * 'b) listFsml.Miscval string_of_list : f:('a -> string) -> sep:string -> 'a list -> stringval iter_fst : (bool -> 'a -> unit) -> 'a list -> unitval list_make : f:(int -> 'a) -> lo:int -> hi:int -> 'a listval flat_map : ('a -> 'b list) -> 'a list -> 'b listval cart_prod : 'a list -> 'b list -> ('a * 'b) listval list_parse : parse_item:(Stdlib.Genlex.token Stdlib.Stream.t -> 'a) -> sep:string -> Stdlib.Genlex.token Stdlib.Stream.t -> 'a listval string_of_opt : ('a -> string) -> 'a option -> stringval bit_size : int -> intval pow2 : int -> intval quote_string : string -> stringval check_dir : string -> unitval spaces : int -> stringval replace_assoc : 'a -> 'b -> ('a * 'b) list -> ('a * 'b) listFsml__Vhdltype config = {mutable state_var : string; | Name of signal storing the current state (default: |
mutable reset_sig : string; | Name of the asynchronous reset input (default: |
mutable clk_sig : string; | Name of the clock input (default: |
mutable use_numeric_std : bool; | Encode integers as VHDL |
mutable act_sem : act_semantics; | Use sequential or synchronous semantics for actions (default: sequential) |
}and act_semantics = val cfg : configval write : ?dir:string -> prefix:string -> Fsml.Fsm.t -> unitwrite prefix m writes in file prefix.vhd a representation of FSM m as a VHDL entity and architecture. The architecture is a synchronous FSM, with a clk signal and a asynchronous, active high, rst signal. Transitions are performed on the rising edge of the clk signal. The generated file is written in the current working directory unless a target directory is specified with the dir argument. If the target directory does not exist, an attempt is made to create it.
Fsml.Vhdltype config = {mutable state_var : string; | Name of signal storing the current state (default: |
mutable reset_sig : string; | Name of the asynchronous reset input (default: |
mutable clk_sig : string; | Name of the clock input (default: |
mutable use_numeric_std : bool; | Encode integers as VHDL |
mutable act_sem : act_semantics; | Use sequential or synchronous semantics for actions (default: sequential) |
}and act_semantics = val cfg : configval write : ?dir:string -> prefix:string -> Fsm.t -> unitwrite prefix m writes in file prefix.vhd a representation of FSM m as a VHDL entity and architecture. The architecture is a synchronous FSM, with a clk signal and a asynchronous, active high, rst signal. Transitions are performed on the rising edge of the clk signal. The generated file is written in the current working directory unless a target directory is specified with the dir argument. If the target directory does not exist, an attempt is made to create it.