AnsweredAssumed Answered

Parameters not being passed to AEL macro

Question asked by vgreer on Jul 28, 2003
Latest reply on Jul 31, 2003 by vgreer

Like • Show 0 Likes0
Comment • 7

I've written an AEL macro to make this double-spiral octagonal transformer. It happens to work pretty well with its default values at the moment. However, I've noticed that when I try to use it in the layout window, the parameters defined in my create_item() fuction don't seem to be passed to the macro. This means that when I have a set of if() statements included that set variables to their defaults if the values passed are inappropriate, I get a beautiful double-spiral just like I want, but all the warnings defined in the if() statements are printed. If I comment out the if() statements, some debugging fprintf() functions spit out a buch of zeros for the spiral verticies, which suggests to me that either all zeros are being passed to the function or uninitialized variables default to zero, which yields the effect I see.

Anyway, to put this into a question, I wrote a file called octagon.ael that contains the create_item() function as well as set_design_type() and library_group() functions, all similar to those in the ic_art_b archive available on this site at

http://edasupportweb.soco.agilent.com/cgi-bin/show.pl?id=8837

The whole idea was to get the macro to show up in the Insert > Component... dialog in the layout window. I also created a file called octagon_art.ael that contains the artwork macro functions. Is this enough? Is there some sort of configuration or additional file I need to create to get parameters to pass to the macro? Let me know if you need more info and I could try to post code in a subthread (this system says the code makes this message to long).

Thanks in advance for your help. I've been looking through the AEL and Design Kit Development documentation for hints on what's happening with no luck and don't know where to go from here.

vgreer

URL updated. support_admin @ Mar 3 2004

No one else has this question

Outcomes

7 Replies

mfredrik Jul 28, 2003 8:18 AM
Mark Correct
Correct Answer
When using associating an AEL artwork macro to a schematic design in ADS it's crucial to get the list of parameters right. The order is the important thing - then names are not. Also, make sure the assign the right data types for the parameters. Keep in mind that the values passed into the AEL artwork macro is always converted into MKS units. For instance, if a length parameter is specified on your component:

L = 1 um

The value of L which is passed into your artwork macro is 1E-6 [meter].

Example macro:

defun my_artwork(L,W)
{

}

Example component using the my_artwork() artwork macro:

MyResistor
L = 1 um
W = 1 mm

=> Result: L = 1E-6 and W=1E-3 passed into the macro.

Another component using the same artwork macro:

MyCapacitor
X = 10 mm
Y = 20 mm

=> Result: L = 10E-3 and W=20E-3 passed into the macro. Note that the names are irrelevant!
Like • Show 0 Likes0
Actions
vgreer Jul 28, 2003 8:30 AM
Mark Correct
Correct Answer
I should mention that this artwork macro is not associated with a schematic or schematic symbol in any way. This is an artwork macro meant to aid in Momentum simulation. Both files have been created with a text editor alone.

vgreer
Like • Show 0 Likes0
Actions
mfredrik Jul 28, 2003 8:41 AM
Mark Correct
Correct Answer
It's not a requirement that the macro is associated with an ADS design. But it could be conventient to do that. You could then place a component in the layout, then just change the values of the parameter(s) to execute the macro and see the generated shape.

There's one big difference though - when you execute the AEL macro directly from the command line or from a custom menu etc, then there is no conversion of the input values to MKS units. When you associate a component with a macro then there is always a conversions to MKS units of the input values.

This does not explain why you are having problems though... We would really have to look at your code to be able to help you further. Can you post a sample of your code here in the forum? Or you can contact Technical Support so that they can work with you directly to solve the problem.

http://eesof.tm.agilent.com/support/supp101.html
Like • Show 0 Likes0
Actions
vgreer Jul 28, 2003 9:03 AM
Mark Correct
Correct Answer
octagon.ael: The file with the create_item() function as well as set_design type() and library_group().

/* This is the effort to create the ael artwork macro for the 2 spiral
octagonal tranformer from scratch. This is what should constitue the
upper end of the specification as this is the create_item() function
file that defines parameters and calls the artwork creation functions.
*/

set_simulator_type(-1); /* the broadest setting */

create_item( //Here we go
"octagon_transformer", // Name
"2 coil symmetric octagonal balun transformer", // Label
"BALUN", // Prefix
ITEM_DESIGN_INST, // attribute (external design as used in
// spiral example) (numeric value is 16)
NULL, // Priority (not used)
"", // Icon Name
standard_dialog, // Dialog code (for editing parameters) may
// be possible to use anything here as coil
// example uses "Component Parameters"
"*", // Dialog Data (manual's usually) (not used)
ComponentNetlistFmt, // Netlist format (Damned if I know so
// we're going with a standard one
"octagon_transformer", // Netlist data (damned if I know so
// following coil example's lead)
standard_symbol, // display format (manual's common value)
"SYM_L", // Symbol Name (the schematic symbol)
2, // artwork type (2 is ael generated artwork)
"octagon_trans", // artwork data (the artwork generating
// function itself)
0, // extra attribute (following coil example's lead. Also,
// the example seems to whole-sale ignore the callback list
// parameter so I will, too, and get on to create_parm's)
/* time to create the parameters!! */
create_parm("W", // Parameter Name
"Line Width", // Parameter Label
PARM_OPTIMIZABLE | PARM_STATISTICAL, // Parameter Attribute
// we'll use these 2
"StdFormSet", // Parameter Form Set (we're following coil
// example's lead)
LENGTH_UNIT, // Parameter Unit Code (numeric value 5)
prm("StdForm", "2.6 um") // Default Value (must be acceptable
// for the form used, that's why
// the prm() function is used
// unused optional callback list parameter
),
create_parm("S", "Line Separation", PARM_OPTIMIZABLE | PARM_STATISTICAL,
"StdFormSet", LENGTH_UNIT, prm("StdForm", "2.1 um")
),
create_parm("N", "Number of Turns", PARM_OPTIMIZABLE | PARM_STATISTICAL,
"StdFormSet", UNITLESS_UNIT, prm("StdForm", "2")
),
create_parm("D", "Coil \"Diameter\"", PARM_OPTIMIZABLE | PARM_STATISTICAL,
"StdFormSet", LENGTH_UNIT, prm("StdForm", "75.2 um")
),
create_parm("coil_sep", "Coil Separation", PARM_OPTIMIZABLE |
PARM_STATISTICAL, "StdFormSet", LENGTH_UNIT, prm("StdForm",
"6.8 um")
)
);
set_design_type(1);
library_group("*", "*", 1, "octagon_transformer");
Like • Show 0 Likes0
Actions
vgreer Jul 28, 2003 9:09 AM
Mark Correct
Correct Answer
octagon_art.ael: The file header with default values and declarations and a chunk of main function.

#voc(SimCmd)

decl grid_size = 0.05; //The grid size
decl via34_size = 0.5; //The via34 length of a size
decl via34_sep = 0.45; //The via34 min separation
decl via34_encl = 0.5; //The min via34 metal enclosure.

/* Layer values for the layers used in this macro. Defined top down. */
decl m4t = 15; // Top of thick metal
decl m4c = 14; // Middle of thick metal
decl m4b = 13; // Bottom of thick metal
decl via34 = 12; // Via between metal 3 and thick metal
decl m3t = 11; // Top of metal 3
decl m3c = 10; // Middle of metal 3
decl m3b = 9; // Bottom of metal 3

/* Please note the default values are minimal. Do not go lower. */
decl W_default = 2.6; // Default line width
decl S_default = 2.1; // Default line separation
decl N_default = 2; // Default number of turns
decl D_default = 75.2; // Default coil ``diameter''
decl coil_sep_default = 6.8; // Default coil separation

defun octagon_trans(W,
S,
N,
D,
coil_sep
)
{
// Variable declarations
decl current_turn_o_o_x; //Array of outer corners for current outer spiral
decl current_turn_o_o_y; //Array of outer corners for current outer spiral
decl current_turn_o_i_x; //Array of inner corners for current outer spiral
decl current_turn_o_i_y; //Array of inner corners for current outer spiral
decl current_turn_i_o_x; //Array of outer corners for current inner spiral
decl current_turn_i_o_y; //Array of outer corners for current inner spiral
decl current_turn_i_i_x; //Array of inner corners for current inner spiral
decl current_turn_i_i_y; //Array of inner corners for current inner spiral
decl outer_o_corners_x; //Array of outer coil's outer corners (resized)
decl outer_o_corners_y; //Array of outer coil's outer corners (resized)
decl outer_i_corners_x; //Array of outer coil's inner corners (resized)
decl outer_i_corners_y; //Array of outer coil's inner corners (resized)
decl inner_o_corners_x; //Array of inner coil's outer corners (resized)
decl inner_o_corners_y; //Array of inner coil's outer corners (resized)
decl inner_i_corners_x; //Array of inner coil's inner corners (resized)
decl inner_i_corners_y; //Array of inner coil's inner corners (resized)
decl current_D; //Varying coil ``diameter'' variable
decl n; // turn counter
decl m; // layer counter
de_set_global_db_factor(); // Trying to ensure MKS unit use
/* check defaults. */
if(W < W_default)
{
warning("oct_err", 1,
"Warning: line width must be at least default value\n", "");
W = W_default;
W = W; //Force copy
}
if(S < S_default)
{
warning("oct_err", 1,
"Warning: line separation must be at least default value\n", "");
S = S_default;
S = S; //Force copy
}
if(N < N_default)
{
warning("oct_err", 1,
"Warning: number of turns must be at least default value\n", "");
N = N_default;
N = N; //Force copy
}
if(D < D_default)
{
warning("oct_err",1,"Warning: coil diameter must be at least default value\n",
"");
D = D_default;
D = D; //Force copy
}
if(coil_sep < coil_sep_default)
{
warning("oct_err",1,
"Warning: coil separation must be at least default value\n", "");
coil_sep = coil_sep_default;
coil_sep = coil_sep; //Force copy
}
/* check (N+2)(2W+2S) >= D/2. if yes, continue, if not, go to default */
if( (N+2)*(2*W+2*S) >= D/2 )
{
warning("oct_err", 1, "Warning: (2W+2S)(N+2) must be greater than D/2\n",
"");
W=W_default;
W=W; //Force copy
S=S_default;
S=S; //Force copy
N=N_default;
N=N; //Force copy
D=D_default;
D=D; //Force copy
}
/* check coil_sep >= 2S+W. if yes, continue, if not, set it so. */
if(coil_sep < 2*S+W)
{
warning("oct_err",1,"Warning: Coil separation must be at least 2S+W.\n",
"");
coil_sep = 2*S+W;
}

/* calculate corners for the outermost turn (most will be dropped) */
current_D = D;
current_D = current_D; //Force copy
turnCalculate(&current_turn_o_o_x, &current_turn_o_o_y,
&current_turn_o_i_x, &current_turn_o_i_y,
current_D, W);
current_D = current_D - 2*W - 2*S;
turnCalculate(&current_turn_i_o_x, &current_turn_i_o_y,
&current_turn_i_i_x, &current_turn_i_i_y,
current_D, W);
/* instansiate with feedlines, outer at upper left, inner at lower left */
Like • Show 0 Likes0
Actions
mfredrik Jul 28, 2003 9:33 AM
Mark Correct
Correct Answer
Thanks for the code sample!

The create_item() code actually creates an ADS design. There's no DSN file, but ADS does recognize this as a design/part which you can place in a layout etc. I got little confused about that..sorry..

Anyway, I think the problem may be in the octagon_art.ael file. I think you use the wrong vocabulary when loading the file.

Try changing:

#voc(SimCmd)

To:

#voc(CmdOp)

Or, you could try this:
- Create a folder somewhere on your system, for instance c:\artwork
- Move the octagon_art.ael file to the new folder
- Remove the #voc(XXXX) line in the octagon_art.ael file
- Edit $HOME\hpeesof\config\de_sim.cfg and add this configuration variable:
  
  USER_AEL=c:\artwork\
- Restart ADS. The AEL file(s) in the c:\artwork folder should have been loaded at bootup (check if the .atf file(s) are created.
- Now you should be able to use your macro from any project / or even the command line if you wished.
Like • Show 0 Likes0
Actions
vgreer Jul 31, 2003 6:58 AM
Mark Correct
Correct Answer
I have gotten the problem resolved. It took an e-mail to technical support, but it's fixed now. Many thanks to Mats Fredriksson of Agilent Tech Support.

It is one of those things that's easy to miss if you aren't familiar with AEL and how ADS's parameter passing works, like me. Let's illustrate with one of the parameters, like W. Notice in octagon.ael, I use prm() statements to set defaults; for W, it is like so:
prm("StdForm", "2.6 um")

In octagon_art.ael you'll see two things affecting this. First, there's a default W set globally in the code:
decl W_default = 2.6; // Default line width

and in the main function checking is done to confirm the parameter passed is not less than this value:
if(W < W_default)
{
warning("oct_err", 1,
"Warning: line width must be at least default value\n", "");
W = W_default;
W = W; //Force copy
}

Herein lies the problem. The form default in octagon.ael is set to 2.6 um. The artwork default in octagon_art.ael is set to just plain 2.6. When ADS receives 2.6 um as a default it converts it to simulator units (right?) which would be meters in this case. So, W is set to 2.6e-6 m when passed from the form. This is, of course, less than 2.6 and, hence, triggered the warning statements as I described.

By changing the defaults so that everything was in meters, I fixed the problem. So, the default W now looks like:
decl W_default = 2.6e-6; // Default line width

This post was about your typical newbie mistake based on a lack of understanding of the system. Thanks to all posters and the good people at Agilent support.

vgreer
Like • Show 0 Likes0
Actions

Parameters not being passed to AEL macro

Outcomes

Related Content

Recommended Content